Nikcio.UHeadless 4.0.0-preview001

This is a prerelease version of Nikcio.UHeadless.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Nikcio.UHeadless --version 4.0.0-preview001                
NuGet\Install-Package Nikcio.UHeadless -Version 4.0.0-preview001                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Nikcio.UHeadless" Version="4.0.0-preview001" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Nikcio.UHeadless --version 4.0.0-preview001                
#r "nuget: Nikcio.UHeadless, 4.0.0-preview001"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Nikcio.UHeadless as a Cake Addin
#addin nuget:?package=Nikcio.UHeadless&version=4.0.0-preview001&prerelease

// Install Nikcio.UHeadless as a Cake Tool
#tool nuget:?package=Nikcio.UHeadless&version=4.0.0-preview001&prerelease                

Nikcio.UHeadless

Quality Gate Status Build UHeadless Nuget Downloads Nuget Version Nuget (with prereleases)

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 Versions
Umbraco 9 v1.x.x & v2.x.x
Umbraco 10 v2.x.x & v3.x.x
Umbraco 11 v3.x.x & v4.x.x
Umbraco 12 v4.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:

  1. Open your Startup.cs file.

  2. Add the following using statement:

    using Nikcio.UHeadless.Extensions;
    
  3. In the ConfigureServices method, add the following code:

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddUmbraco(_env, _config)
            /* Code omitted for clarity */
            .AddUHeadless()
            /* Code omitted for clarity */
    }
    
  4. In the Configure method, add the following code:

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        /* Code omitted for clarity */
    
        app.UseUHeadlessGraphQLEndpoint();
    
        app.UseUmbraco()
        /* etc... */
    }
    

With these configurations in place, your content will be available at /graphql. To get started, try adding some content to the root and run the following query:

{
  contentAtRoot {
    nodes {
      id,
      name
    }
  }
}

Documentation

For detailed documentation and usage instructions, please refer to the Nikcio.UHeadless Documentation.

Extending Packages

Nikcio.UHeadless offers various packages for extending its functionality. The following table lists the available packages and their current status:

Package Name Status
Nikcio.UHeadless.Content Included*
Nikcio.UHeadless.Media Included*
Nikcio.UHeadless.ContentTypes Included*
Nikcio.UHeadless.Members Available
Nikcio.UHeadless.DataTypes Not started
Nikcio.UHeadless.Dictionary Not started
Nikcio.UHeadless.MediaTypes Not started
Nikcio.UHeadless.MemberTypes Not started

*Included indicates that the package is included in the Nikcio.UHeadless NuGet package.

**Preview indicates that the package is available in a preview version.

Please note that if a Nikcio.UHeadless.* package is not listed above, it either means that the package is not ready for use or it is a core/base package used in the packages mentioned above.

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.

It is important to note that the versioning of Nikcio.UHeadless does not align with Umbraco's major versions. To manage compatibility, the following versioning tactic has been adopted:

Versioning Tactic

Each Umbraco LTS (Long-Term Support) version is associated with a corresponding UHeadless LTS version. Any other UHeadless majors that are not marked as LTS will cease to receive support when a new major version is released. This approach allows you, as a developer, to choose the frequency of updates for both UHeadless and Umbraco.

The versioning tracks are as follows:

Track UHeadless Version Supported Umbraco Version
LTS v3.x.x v10.x.x & v11.x.x
Edge v3.x.x v10.x.x & v11.x.x
Current Stable v3.x.x v10.x.x & v11.x.x

Please note that LTS versions do not receive new features but will receive bug fixes when a newer major version is available.

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 Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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 436 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,809 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