Skip to content

Common classes for a REST project with access to MongoDB

Notifications You must be signed in to change notification settings

danielso2007/commons-rest-api

Repository files navigation

CodeFactor CommonsRestAPI GitHub package version GitHub pull requests GitHub issues GitHub last commit GitHub issue/pull request author GitHub contributors GitHub top language GitHub GitHub All Releases Conventional Commits

Commons REST API

Common classes for a REST project with access to MongoDB. Use this API for a complete REST project with Swagger and Hateoas.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing

Just compile with Java 11 and use it as a dependency on your Spring Boot REST java project.

API documentation - swagger (OpenAPI 3):

The application uses the swagger to display the API documentation. To check, access the links swagger-ui and api-docs. Documentation swagger.io and springdoc.org.

More examples: documenting-spring-boot-rest-api-springdoc-openapi-3

Or add the path below:

http://localhost:8080/swagger-ui.html

http://localhost:8080/api-docs

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

Usamos SemVer para versionar. Para as versões disponíveis, consulte as tags neste repositório.

Authors

See also the list of contributors who participated in this project.