Skip to content

Commit 66c5f94

Browse files
committed
feat: Spring usando o OpenAPI 3.0 (#6).
1 parent 09ca2ae commit 66c5f94

18 files changed

+421
-254
lines changed

README.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,29 @@ Para "rodar" a imagem, execute:
6666
docker run -p 8080:8080 --name swapi virtualLibraryAPI:<project.version>
6767
```
6868

69+
### Documentação da API - swagger (OpenAPI 3):
70+
71+
A aplicação usa o swagger para a exibição da documentação da API. Para verificar, acesse os links [swagger-ui](http://localhost:8080/swagger-ui.html) e [api-docs](http://localhost:8080/api-docs). Documentação [swagger.io](https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/) e [springdoc.org](https://springdoc.org/).
72+
73+
Mais exemplos: [documenting-spring-boot-rest-api-springdoc-openapi-3](https://www.dariawan.com/tutorials/spring/documenting-spring-boot-rest-api-springdoc-openapi-3/)
74+
75+
Ou adicione o caminho abaixo:
76+
77+
```
78+
http://localhost:8080/swagger-ui.html
79+
80+
http://localhost:8080/api-docs
81+
```
82+
6983
### Teste o endereço docker (login: admin / password: admin):
7084

7185
```
72-
http://localhost:8080/swagger-ui.html#/
86+
http://localhost:8080/api/v1/books
87+
88+
http://localhost:8080/api/v1/ratings
7389
```
7490

75-
Inicialmente só é criada a imagem da api. Posteriormente mostrarei como executar o `docker-compose` criado no build, para a execução completa da api com o banco de dados MongoDb.
91+
Inicialmente só é criada a imagem da API. Posteriormente mostrarei como executar o `docker-compose` criado no build, para a execução completa da api com o banco de dados MongoDb.
7692

7793
## Running with docker-compose
7894

package-lock.json

+154-36
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+6
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
"release": "standard-version",
77
"test": "mvn -q test -P test"
88
},
9+
"standard-version": {
10+
"scripts": {
11+
"postbump": "node set-pom-version.js",
12+
"postcommit": "git add pom.xml && git commit --amend --no-edit"
13+
}
14+
},
915
"repository": {
1016
"type": "git",
1117
"url": "git+https://github.com/danielso2007/virtualLibraryAPI.git"

0 commit comments

Comments
 (0)