https://github.com/alessandro1918/swagger-api
Um exemplo de documentação de rotas de API com Swagger. Especificação de endpoints, parâmetros, retorno, tudo facilmente documentável e consultável em uma página web disponível em uma rota da própria API.
https://github.com/alessandro1918/swagger-api
openapi swagger
Last synced: 10 months ago
JSON representation
Um exemplo de documentação de rotas de API com Swagger. Especificação de endpoints, parâmetros, retorno, tudo facilmente documentável e consultável em uma página web disponível em uma rota da própria API.
- Host: GitHub
- URL: https://github.com/alessandro1918/swagger-api
- Owner: Alessandro1918
- Created: 2023-01-16T20:17:01.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-22T20:04:52.000Z (about 2 years ago)
- Last Synced: 2024-01-22T23:30:47.351Z (about 2 years ago)
- Topics: openapi, swagger
- Language: JavaScript
- Homepage: https://swagger-api-kappa.vercel.app
- Size: 1.04 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# swagger-api
## 🚀 Projeto
Um exemplo de documentação de rotas de API com Swagger. Especificação de endpoints, parâmetros, retorno, tudo facilmente documentável e consultável em uma página web disponível em uma rota da própria API.
Confira online! [https://swagger-api-kappa.vercel.app/api-docs/](https://swagger-api-kappa.vercel.app/api-docs/)
## 🛠️ Tecnologias
- [Swagger](https://swagger.io)
- [swagger-jsdoc](https://www.npmjs.com/package/swagger-jsdoc)
- [swagger-ui-express](https://www.npmjs.com/package/swagger-ui-express)
## 🧊 Cool features
- Autenticação de usuários (login) com [JWT](https://jwt.io) para uso das rotas autenticadas.
- Controle de sessão de usuário com accessToken(validade curta (ex.: 5 min)) e refreshToken(revalida sessão automaticamente sem precisar repetir login).
- Limite de acessos por período (Ex.: 60 requests por minuto).
- Requisições de envio de dados (JSON) e arquivos (Multipart form).
## 🗂️ Utilização
### 🐑🐑 Clonando o repositório:
```bash
$ git clone url-do-projeto.git
```
### ▶️ Rodando o App:
```bash
$ cd swagger-api #change to that directory
$ cp .env.example .env #create the ".env" file like the ".env.example" file
$ npm install #download dependencies to node_modules
$ npm run dev #start the project
```
Consultar a documentação em: [localhost:4000/api-docs](http://localhost:4000/api-docs)
## ⭐ Like, Subscribe, Follow!
Curtiu o projeto? Marque esse repositório com uma Estrela ⭐!