restcountries
swagger-core
| restcountries | swagger-core | |
|---|---|---|
| 1 | 5 | |
| 2,213 | 7,347 | |
| 0.3% | 0.3% | |
| 0.0 | 8.3 | |
| 6 months ago | 7 days ago | |
| Java | Java | |
| Mozilla Public License 2.0 | 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.
restcountries
-
Build cool charts and visualize data with d3.js
We are going to use restcountries API.
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?
REST Assured - Java DSL for easy testing of REST services
springdoc-openapi - Library for OpenAPI 3 with spring-boot
d3 - Bring data to life with SVG, Canvas and HTML. :bar_chart::chart_with_upwards_trend::tada:
openapi4j - OpenAPI 3 parser, JSON schema and request validator.
d3-scale - Encodings that map abstract data to visual representation.
Swashbuckle.AspNetCore - Swagger tools for documenting API's built on ASP.NET Core
utoipa - Simple, Fast, Code first and Compile time generated OpenAPI documentation for Rust
drf-spectacular - Sane and flexible OpenAPI 3 schema generation for Django REST framework.
swagger-maven-plugin - JAX-RS & SpringMVC supported maven build plugin, helps you generate Swagger JSON and API document in build phase.
swagger-brake - Swagger contract checker for breaking API changes
nocode - The best way to write secure and reliable applications. Write nothing; deploy nowhere.
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.