https://github.com/theduardomaciel/java-spring
https://github.com/theduardomaciel/java-spring
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/theduardomaciel/java-spring
- Owner: theduardomaciel
- Created: 2024-07-20T04:22:29.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-07-21T21:41:13.000Z (10 months ago)
- Last Synced: 2025-02-01T20:11:32.069Z (3 months ago)
- Language: Java
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Spring Boot REST API
Este projeto é um exemplo de uma simples API RESTful desenvolvida com Spring Boot.
### Documentação
A documentação foi implementada com o pacote `springdoc-openapi`, que gera automaticamente a documentação da API em formato OpenAPI 3.0.
A documentação é gerada automaticamente a partir dos métodos dos controladores.
Para acessar a documentação, execute o projeto e acesse a URL `http://localhost:8080/swagger-ui.html` ou use o pseudônimo `http://localhost:8080/docs`.
> [!NOTE]
> Para alterar o pseudônimo, edite o arquivo `application.properties` e edite a seguinte propriedade:
> ```properties
> springdoc.api-docs.path=/docs
> ```
A documentação também está disponível em formato JSON na URL `http://localhost:8080/v3/api-docs`.