NSwag
swagger-core
Our great sponsors
NSwag | swagger-core | |
---|---|---|
1 | 5 | |
5,186 | 7,338 | |
- | 0.3% | |
9.1 | 8.3 | |
almost 2 years ago | 5 days ago | |
C# | Java | |
MIT License | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
NSwag
-
Auto OpenAPI Generation — The Network Doesn’t Lie!
Examples include Swagger-Core, SpringFox, NSwag / Swashbuckle, Swagger-express / HAPI-Swagger, Django-REST-Swagger / Flask-RESTplus, etc.
swagger-core
-
Auto OpenAPI Generation — The Network Doesn’t Lie!
Examples include Swagger-Core, SpringFox, NSwag / Swashbuckle, Swagger-express / HAPI-Swagger, Django-REST-Swagger / Flask-RESTplus, etc.
-
OpenAPI Specification: The Complete Guide
JAX-RS is a java implementation of the OpenAPI Specification. - GitHub - swagger-api/swagger-core
-
URL Shortener: Java & Spring complete tutorial
Now Swagger UI is configured and we can start documenting our API. Inside UrlController, above every endpoint, we can use @ApiOperation annotation to add description. Depending on your needs you can use some other annotations.
-
Using Swagger API
Here is an example from Swagger APIs GitHub:
-
Organize code by concepts, not layers
Im mostly in C# land nowadays, but this seems to be the java version. I’m not sure it is as deeply integrated, as I think Java has a few popular server frameworks.
What are some alternatives?
Swashbuckle - Seamlessly adds a swagger to WebApi projects! [Moved to: https://github.com/domaindrivendev/Swashbuckle.WebApi]
springdoc-openapi - Library for OpenAPI 3 with spring-boot
swagger-express - Swagger + Express = {swagger-express}
openapi4j - OpenAPI 3 parser, JSON schema and request validator.
VueSimpleTemplate - A minimal dotnet template for Vuejs 3.X using Single File Component.
Swashbuckle.AspNetCore - Swagger tools for documenting API's built on ASP.NET Core
aspnet-api-versioning - Provides a set of libraries which add service API versioning to ASP.NET Web API, OData with ASP.NET Web API, and ASP.NET Core. [Moved to: https://github.com/dotnet/aspnet-api-versioning]
utoipa - Simple, Fast, Code first and Compile time generated OpenAPI documentation for Rust
AspNetTwilioMinAPI - Build an ASP.NET Minimal API for use with Twilio Messaging and Voice
drf-spectacular - Sane and flexible OpenAPI 3 schema generation for Django REST framework.
Flask RestPlus - Fully featured framework for fast, easy and documented API development with Flask
swagger-maven-plugin - JAX-RS & SpringMVC supported maven build plugin, helps you generate Swagger JSON and API document in build phase.