Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 2.02 KB

README.md

File metadata and controls

69 lines (44 loc) · 2.02 KB
Raw

GraphQL for Umbraco

NuGet release

What is this

An implementation of GraphQL for Umbraco using GraphQL for .NET.

Please note this should not be used in production, since there are no security and all you data will be publicly available.

How does it work

GraphQL types are dynamically generated for all Umbraco document types (content and media), with all the properties as fields.

Installation

The preferred way to install GraphQL for Umbraco is through NuGet

Option 1: NuGet

GraphQL for Umbraco is available as a NuGet package.

To install run the following command in the Package Manager Console

PM> Install-Package Our.Umbraco.GraphQL

Option 2: From source

Clone the repository and run the Website (F5 in Visual Studio), install Umbraco with the starter kit and start exploring the API using the GraphQL Playground by opening /umbraco/graphql.

Docs

The docs can be found here

TODO

  • GraphQL Playground
  • Schema Stitching (extending types)
  • Metrics
  • Published Content
  • Published Media
  • Dictionary
  • Statistics (field usage etc.)
  • Deprecation (Content Types and Properties)
  • API Tokens (OAUTH) with permissions (for content types and properties)
  • Data Types
  • Document Types
  • Media Types
  • Member Types
  • Content
  • Media
  • Members
  • Documentation

Contributing

Anyone can help make this project better - check out our Contributing guide

Authors

License

Copyright © 2018 Rasmus John Pedersen

GraphQL for Umbraco is released under the MIT License