kinde-oss / kinde-dotnet-generator

OpenAPI generator for Kinde .NET SDK

Kinde .NET generator

The generator for the Kinde .NET SDK.

Overview

This generator creates an SDK in .NET that can authenticate to Kinde using the Authorization Code grant or the Authorization Code with PKCE grant via the OAuth 2.0 protocol. It can also access the Kinde Management API using the client credentials grant.

Also, see the SDKs section in Kinde’s contributing guidelines.

Usage

Initial set up

1. Clone the repository to your machine:

   git clone https://github.com/kinde-oss/kinde-dotnet-generator.git

2. Go into the project:

   cd kinde-dotnet-generator

3. Install the OpenAPI Generator tool:

   https://openapi-generator.tech/docs/installation

SDK generation

Run the following command to generate the SDK:

openapi-generator-cli generate -i https://kinde.com/api/kinde-mgmt-api-specs.yaml -g csharp -o Kinde.Sdk --package-name=Kinde.Api -c config.yaml --library=httpclient --additional-properties=targetFramework=net6.0,packageVersion=1.2.7,sourceFolder=

Note: The API specifications should always point to Kinde's hosted version: https://kinde.com/api/kinde-mgmt-api-specs.yaml. This is set via the -i option in the OpenAPI Generator CLI, for example:

openapi-generator-cli generate -i https://kinde.com/api/kinde-mgmt-api-specs.yaml

The SDK gets outputted to: Kinde.Sdk, which you can enter via:

cd Kinde.Sdk

Folder Kinde.Sdk contains our final SDK after build. In order to copy files generated from Kinde.Sdk folder to the development repository, eg: ../kinde-dotnet-sdk , please run

cp -r Kinde.Sdk/Kinde.Api ../kinde-dotnet-sdk/

SDK documentation

.NET SDK

Development

The instructions provided in the "Usage → Initial set up" section above are sufficient to get you started.

Contributing

Please refer to Kinde’s contributing guidelines.

License

By contributing to Kinde, you agree that your contributions will be licensed under its MIT License.

kinde-dotnet-generator's Issues

Feature request: Merge generator with SDK repository

Prerequisites

• I have searched the repository’s issues, Kinde community and public roadmap to ensure my feature request isn’t a duplicate
• I have read the contributing guidelines
• I agree to the terms within the code of conduct

What is the problem you’re trying to solve?

There is extra overhead with maintaining and updating two repositories and things become out of sync.

What solution would you like to see?

Combine the repositories like we did with the TypeScript SDK.

Additional information

No response

Documentation issue: Update README to Kinde's OSS Template

Prerequisites

• I have searched the repository’s issues and the Kinde community to ensure my documentation issue isn’t a duplicate
• I have read the contributing guidelines
• I agree to the terms within the code of conduct

How can we improve the docs or what is missing?

Update README to Kinde's OSS template for generator - https://github.com/kinde-oss/kinde-oss-repo-template/blob/main/README_template_generator.md

Provide extra context, such as what you were trying to do and your requirements

N/A

If the docs page already exists, please provide a link

No response