Skip to content

TypedRest/CodeGeneration

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
doc
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

TypedRest Code Generation

Build
Tool that automatically infers TypedRest Endpoints from patterns in OpenAPI/Swagger documents and generates source code for TypedRest clients.

Usage

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.

Custom code

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:

TypedRest.OpenApi
Parses OpenAPI/Swagger documents and infers TypedRest Endpoints from patterns.

TypedRest.OpenApi.CSharp
Generates C# source code for TypedRest .NET clients from OpenAPI/Swagger documents.

For further information take a look a the API Documentation.

References:

Building

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.ps1 or ./build.sh (.NET SDK is automatically downloaded if missing using 0install).

Contributing

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.

About

Generate TypedRest clients from OpenAPI/Swagger specifications

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages 3