Skip to content

Open API specification

You SHOULD write an OpenAPI specification before generating server-side code.

A design-first approach SHOULD be used to enable earlier testing and validation. However, you MAY adopt a code-first approach where it better suits the needs of your project. Refer to the Documentation section for further guidance.

Practical tips

Use the API platform team's Open API template to ensure your API includes required security schemas and essential operations like Ping and Status.

Further reading and information

OpenAPI Specification - Version 3.1.0 | Swagger

OpenAPI & .NET: You're Doing It Wrong - Mark Rendle - NDC London 2023

C# ASP.NET 5 - Designing Web APIs with Swagger aka OpenAPI Specification