UrlShortener-API
swagger-core
Our great sponsors
| UrlShortener-API | swagger-core | |
|---|---|---|
| 1 | 5 | |
| 70 | 7,338 | |
| - | 0.3% | |
| 0.0 | 8.3 | |
| over 1 year ago | 4 days ago | |
| Java | 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.
UrlShortener-API
-
URL Shortener: Java & Spring complete tutorial
Note: The whole solution is on my Github. I implemented this service using Spring boot and MySQL.
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?
spring-security-jwt-auth-poc - Java backend application using Spring-security to implement JWT based Authentication and Authorization [Moved to: https://github.com/hardikSinghBehl/jwt-auth-flow-spring-security]
springdoc-openapi - Library for OpenAPI 3 with spring-boot
cqrs-example - Spring Boot CQRS Example (Docker, Apache Kafka, Zookeeper, MYSQL, MongoDB)
openapi4j - OpenAPI 3 parser, JSON schema and request validator.
springboot-docker-example - Very basic SpringBoot application paired up with MySQL as database to demonstrate the usage of Docker and docker compose in my blog
Swashbuckle.AspNetCore - Swagger tools for documenting API's built on ASP.NET Core
spring-boot-postgresql-jpa-hibernate-rest-api-demo - Building RESTful APIs with Spring Boot, PostgreSQL, JPA and Hibernate
utoipa - Simple, Fast, Code first and Compile time generated OpenAPI documentation for Rust
FlexiCore - FlexiCore is a plugin based spring powered framework
drf-spectacular - Sane and flexible OpenAPI 3 schema generation for Django REST framework.
Docker Compose - Define and run multi-container applications with Docker
swagger-maven-plugin - JAX-RS & SpringMVC supported maven build plugin, helps you generate Swagger JSON and API document in build phase.