nseguin/WebApiBootstrap
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
An example of a web API with an auto-generated client library.
15 commits 1 branch 0 tags 56 KiB
C# 100%
Find a file
Nick Seguin 9a40eb18e9
use single static JsonSerializerOptions instance for MyApiClient
2024-02-13 19:35:52 -06:00
.config add client and contracts project 2024-02-13 18:37:09 -06:00
src use single static JsonSerializerOptions instance for MyApiClient 2024-02-13 19:35:52 -06:00
tests/SampleApp reformat and cleanup 2024-02-13 19:33:29 -06:00
.editorconfig add client and contracts project 2024-02-13 18:37:09 -06:00
.gitignore initial commit 2024-02-13 17:42:27 -06:00
Directory.Build.props restore dotnet tools before invoking refitter 2024-02-13 19:09:23 -06:00
openapi.yaml add client and contracts project 2024-02-13 18:37:09 -06:00
README.md reformat and cleanup 2024-02-13 19:33:29 -06:00
WebApiBootstrap.sln add sample app 2024-02-13 18:44:38 -06:00

README.md

WebApiBootstrap

Demonstrates a setup for automatically generating a client library for an ASP.NET Core Web Api using OpenAPI ( Swashbuckle) and Refitter.

How it Works

The setup consists of 3 projects:

  • WebApiBootstrap.Api - An ASP.NET Core Web API project.
  • WebApiBootstrap.Contracts - A netstandard2.0 class library containing data transfer objects (DTOs).
  • WebApiBootstrap.Client - A class library containing a client for the API project.

The Api and Client projects have a common dependency on the Contracts project, allowing them to share identical definitions for the DTOs and any associated serialization or validation logic.

The Api project is configured to generate an OpenApi document with Swashbuckle after it is built (see the "GenerateOpenApiDoc" target in its .csproj file).

The Client project uses this file to generate a file containing one or more Refit interface(s). The model generation is skipped so that the client can use the DTOs defined manually in the Contracts project. This interface generation occurs automatically before the Client project is built (see the "GenerateRefitInterface" target in its .csproj file).