This is an alternative implementation of the existing ASP.NET Core codegen which addressed some practical issues we had during the implementation of our REST API.
Most notably:
- It creates abstract base classes with the necessary attributes. Implementing your controller means sub-classing the abstract base classes. Advantage: When your schema changes, only the abstract base class definitions get overwritten. The C# compiler gives your errors for methods not implemented yet.
- All router handlers are
asyncby default. - Route handlers don't get grouped by tag but by path. Now you can use the tags again for grouping paths in Swagger UI.
- It doesn't use Swashbuckle. What's the point in creating the schema for Swagger UI from the code when the code was itself already created by the schema?
- It creates stubs for tests as well!
- Use
swagger-codegen-cli - Use
swagger-codegen-maven-pluginwith the provided pom.xml as an example. Runmvn compileon the command line to generate your C# code. Yeah I think that's funny, too!
Check out the obligatory petshop example in the repository.
swagger-gen-aspnetcore now depends on version 2.2.1 of swagger-codegen. Go into the source directory and run mvn install to build and install
swagger-gen-aspnetcore into your local .m2 directory.
Packaged versions starting from 0.9.1 are available on Bintray.
The goal of Swagger™ is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via Swagger, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, Swagger removes the guesswork in calling the service.
Check out OpenAPI-Spec for additional information about the Swagger project, including additional libraries with support for other languages and more.