Nobly.SignatureApiClient 26.8.4.1

Nobly.SignatureApiClient

Auto-generated C# client (NSwag) for the Nobly Signature API. Published to NuGet as Nobly.SignatureApiClient.

Usage

The client is generated with injectHttpClient and an IApiClient interface, so it plugs straight into DI:

services.AddHttpClient<IApiClient, ApiClient>(httpClient => {
	// BaseUrl can also be set via the generated BaseUrl property.
});

// Or manually:
HttpClient httpClient = new HttpClient();
ApiClient client = new ApiClient(httpClient) { BaseUrl = "https://your-signature-api-host" };

Modify and publish NoblySignatureApiClient

1. Check out Nobly Signature (Nobly Signature repository) master branch and run the API locally: dotnet run --project NoblySignatureApi --launch-profile http
   • If you have no Azure Key Vault access configured locally, disable it first by setting the environment variable AzureKeyVaultConfiguration__Enabled=false (the Swagger spec generation does not need any secrets).
2. Download the OpenAPI spec from the running API and save it over NoblySignatureApiClient\openapi.json: http://localhost:5070/swagger/v1/swagger.json (also linked at the top of the Swagger UI page: http://localhost:5070/swagger).
3. Check out NoblySignatureApiClient master branch and create a new branch from it.
4. Regenerate ApiClient.cs from the repository root:

   dotnet tool restore
   cd NoblySignatureApiClient
   dotnet nswag run "generate client.nswag"
   

   (Alternatively, install NSwagStudio, open generate client.nswag in it and click Generate Files.)
5. Compare the newly generated client method signatures with the existing ones (see Important note below) and check the openapi.json diff.
6. Increment the version numbers in NoblySignatureApiClient.csproj (Version, AssemblyVersion, FileVersion, PackageTags). The scheme is date-based: YY.M.D.build, e.g. 26.8.4.1 for the first build on 2026-08-04.
7. Build the project — the NuGet package is generated automatically on build: dotnet build -c Release → NoblySignatureApiClient\bin\Release\Nobly.SignatureApiClient.{version}.nupkg
8. Update this ReadMe with the new version as a title below, listing new endpoints, changed signatures and other important changes.
9. Commit the branch to GitHub and merge into master.
10. Create a Git tag on the merge commit of master with the same version as in the .csproj file and push it: git tag -a 26.8.4.1 -m "26.8.4.1" && git push origin 26.8.4.1
11. Publish the package to NuGet (API key is the Nobly NuGet account token): dotnet nuget push "NoblySignatureApiClient\bin\Release\Nobly.SignatureApiClient.26.8.4.1.nupkg" -k <NUGET-API-KEY> -s https://api.nuget.org/v3/index.json

Important note: Client methods are susceptible to change since NSwag will only include the HTTP method in client names when there is a name conflict, e.g., if there is a GET and a POST method with the same route. So, if there is no signature conflict for a method and another endpoint is added with the same signature but a different HTTP method, the original client method name will change, i.e., it will subsequently include the HTTP method in its client method name. E.g. if only a GET method exists for the endpoint Document, this would generate a DocumentAsync client method, but if a POST method with the same route were added, the DocumentAsync client method name would change to DocumentGetAsync. This means that method signatures in a newly generated client should always be compared to the ones in the existing client to detect whether any client method signatures have changed. Changed method signatures will need to be modified accordingly in any consuming code.

Version history

v.26.8.4.1

• Initial client generated from the Nobly Signature API OpenAPI spec.