Nikcio.UHeadless
5.0.0-preview005
See the version list below for details.
dotnet add package Nikcio.UHeadless --version 5.0.0-preview005
NuGet\Install-Package Nikcio.UHeadless -Version 5.0.0-preview005
<PackageReference Include="Nikcio.UHeadless" Version="5.0.0-preview005" />
paket add Nikcio.UHeadless --version 5.0.0-preview005
#r "nuget: Nikcio.UHeadless, 5.0.0-preview005"
// Install Nikcio.UHeadless as a Cake Addin #addin nuget:?package=Nikcio.UHeadless&version=5.0.0-preview005&prerelease // Install Nikcio.UHeadless as a Cake Tool #tool nuget:?package=Nikcio.UHeadless&version=5.0.0-preview005&prerelease
Nikcio.UHeadless
Welcome to Nikcio.UHeadless, a powerful package that enables you to create a headless GraphQL interface for your Umbraco CMS. This package provides an easy to setup solution for exposing your data and offers a wide range of extensibility options to tailor the headless functionality to your specific needs.
Compatibility
The Nikcio.UHeadless package is compatible with the following Umbraco versions:
Umbraco version | Supported Version |
---|---|
Umbraco 10 | v3.x.x |
Umbraco 12 | v4.x.x |
Umbraco 13 | v4.2.x+ & v5.x.x |
For more information, please refer to the Versioning section.
Setup
Installation
To install the Nikcio.UHeadless package, run the following command:
dotnet add Nikcio.UHeadless
You can also find the package on NuGet.
Integration
To integrate the package into your project, follow these steps:
Open your
Program.cs
file.Add the following using statements:
using Nikcio.UHeadless; using Nikcio.UHeadless.Defaults.ContentItems;
On the
UmbracoBuilder
, add the following code:builder.CreateUmbracoBuilder() // Default Umbraco configuration .AddUHeadless(options => { options.DisableAuthorization = true; // Change this later when adding authentication - See documentation options.AddDefaults(); options.AddQuery<ContentByRouteQuery>(); options.AddQuery<ContentByGuidQuery>(); }) .Build();
Then after the
app.BootUmbracoAsync()
method, add the following code:await app.BootUmbracoAsync(); app.UseAuthentication(); app.UseAuthorization(); GraphQLEndpointConventionBuilder graphQLEndpointBuilder = app.MapUHeadless(); // Only enable the GraphQL IDE in development if (!builder.Environment.IsDevelopment()) { graphQLEndpointBuilder.WithOptions(new GraphQLServerOptions() { Tool = { Enable = false, } }); } app.UseUmbraco() // Default Umbraco configuration
With these configurations in place, your content will be available at /graphql
.
To get started, try querying your content using their GUIDs or routes. For example with the query below:
Tip: GUIDs can be found in the info tab when viewing content in the backoffice
query {
contentByGuid(id: "dcf18a51-6919-4cf8-89d1-36b94ce4d963") {
id
key
name
statusCode
templateId
updateDate
url(urlMode: ABSOLUTE)
urlSegment
}
}
Documentation
For detailed documentation and usage instructions, please refer to the Nikcio.UHeadless Documentation.
Versioning
Nikcio.UHeadless follows the principles of Semantic Versioning to ensure consistency. The version numbers have the following meaning:
vX.Y.Z
- X (Major): Indicates a breaking change.
- Y (Minor): Signifies a feature change.
- Z (Patch): Represents bug fixes.
Full version table
Umbraco version | Supported Versions | Development |
---|---|---|
Umbraco 9 | v1.x.x & v2.x.x | No development |
Umbraco 10 | v2.x.x & v3.x.x | Only reported issues for v3.x.x |
Umbraco 11 | v3.x.x & v4.x.x | No development |
Umbraco 12 | v4.x.x | Only reported issues for v4.x.x |
Umbraco 13 | v4.2.x+ & v5.x.x | Active branch (v5.x.x) |
Contributing
We welcome contributions to Nikcio.UHeadless. Please refer to the Contributing Guide for more information on how to get involved.
Sponsor Nikcio.UHeadless Development
If you find Nikcio.UHeadless valuable and would like to support its ongoing development, consider sponsoring the project through GitHub Sponsors. Your sponsorship helps ensure the continued improvement and maintenance of this package. Thank you for your support!
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net8.0
- HotChocolate.AspNetCore (>= 13.9.5)
- HotChocolate.AspNetCore.Authorization (>= 13.9.5)
- Microsoft.AspNetCore.Authentication.JwtBearer (>= 8.0.6)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
- Umbraco.Cms.Web.Common (>= 13.0.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Nikcio.UHeadless:
Package | Downloads |
---|---|
Nikcio.UHeadless.Defaults
Default models for the Nikcio.UHeadless package |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
6.0.0 | 112 | 11/20/2024 |
6.0.0-preview001 | 97 | 8/29/2024 |
5.1.0 | 152 | 11/20/2024 |
5.0.0 | 411 | 6/26/2024 |
5.0.0-preview005 | 98 | 6/9/2024 |
5.0.0-preview004 | 131 | 5/6/2024 |
5.0.0-preview003 | 122 | 4/12/2024 |
4.2.2 | 165 | 8/29/2024 |
4.2.1 | 1,405 | 4/9/2024 |
4.2.0 | 123 | 4/6/2024 |
4.2.0-preview002 | 117 | 3/7/2024 |
4.1.1 | 5,419 | 8/2/2023 |
4.1.0 | 437 | 7/2/2023 |
4.0.0 | 2,884 | 6/12/2023 |
4.0.0-preview002 | 142 | 6/7/2023 |
4.0.0-preview001 | 119 | 6/6/2023 |
3.3.1 | 949 | 6/2/2023 |
3.3.0 | 4,283 | 1/18/2023 |
3.2.0 | 4,810 | 11/22/2022 |
3.1.0 | 392 | 11/16/2022 |
3.0.6 | 521 | 11/3/2022 |
3.0.5 | 510 | 10/18/2022 |
3.0.4 | 767 | 10/5/2022 |
3.0.3 | 437 | 10/5/2022 |
3.0.2 | 487 | 9/19/2022 |
3.0.1 | 484 | 9/3/2022 |
3.0.0 | 826 | 8/3/2022 |
3.0.0-preview003 | 175 | 8/3/2022 |
3.0.0-preview002 | 193 | 7/16/2022 |
3.0.0-preview001 | 169 | 7/16/2022 |
2.3.1 | 262 | 6/2/2023 |
2.3.0 | 668 | 7/6/2022 |
2.2.1 | 542 | 6/19/2022 |
2.2.0 | 809 | 6/6/2022 |
2.1.1 | 538 | 5/22/2022 |
2.1.0 | 577 | 5/10/2022 |
2.0.2 | 513 | 5/9/2022 |
2.0.1 | 517 | 5/4/2022 |
2.0.0 | 570 | 5/1/2022 |
2.0.0-preview.3 | 127 | 4/26/2022 |
2.0.0-preview.2 | 124 | 4/26/2022 |
2.0.0-preview.1 | 152 | 4/24/2022 |
2.0.0-preview.0 | 129 | 4/14/2022 |
1.3.0 | 687 | 3/5/2022 |
1.2.0 | 600 | 3/1/2022 |
1.1.0 | 563 | 2/26/2022 |
1.0.0 | 643 | 2/6/2022 |
0.1.7-beta | 159 | 2/5/2022 |
0.1.6-beta | 171 | 2/5/2022 |
0.1.5-beta | 173 | 2/4/2022 |
0.1.4-beta | 188 | 1/27/2022 |
0.1.3-beta | 191 | 1/27/2022 |
0.1.2-alpha | 183 | 1/25/2022 |