Make sure you have the .NET SDK 6.0+ installed and run:
dotnet tool install -g typedrest-codegen
You can now use the
typedrest-codegen command-line tool:
typedrest-codegen generate -f myapi.yml -o myclient/
For further information take a look a the Documentation.
If you want to generate clients for more complex APIs you may need to add custom code. You can do this by creating your own command-line tools and using these NuGet packages:
Generates C# source code for TypedRest .NET clients from OpenAPI/Swagger documents.
For further information take a look a the API Documentation.
The source code is in
src/, config for building the API documentation is in
doc/ and generated build artifacts are placed in
artifacts/. The source code does not contain version numbers. Instead the version is determined during CI using GitVersion.
To build run
./build.sh (.NET SDK is automatically downloaded if missing using 0install).
We welcome contributions to this project such as bug reports, recommendations and pull requests.
This repository contains an EditorConfig file. Please make sure to use an editor that supports it to ensure consistent code style, file encoding, etc.. For full tooling support for all style and naming conventions consider using JetBrains' ReSharper or Rider products.