Repositório de aprendizado prático sobre documentação e consumo de APIs REST utilizando Swagger UI e a especificação OpenAPI — desenvolvido durante o curso de Análise e Desenvolvimento de Sistemas.
Compreender na prática como APIs REST são estruturadas, documentadas e testadas — base essencial para o desenvolvimento back-end e para integração entre sistemas.
| Conceito | Descrição |
|---|---|
| 🔗 Endpoints REST | Estrutura de rotas (GET, POST, PUT, DELETE) |
| 📋 OpenAPI Specification | Definição de contratos de API em YAML/JSON |
| 🖥️ Swagger UI | Interface visual para explorar e testar endpoints |
| 📦 Schemas e Models | Definição de estrutura de dados de request e response |
| Uso correto de códigos de resposta (200, 201, 400, 404, 500) | |
| 🔒 Parâmetros | Path params, query params, headers e body |
- JavaScript / Node.js: runtime e estrutura do projeto
- Swagger UI: visualização e teste interativo da API
- OpenAPI 3.0: especificação do contrato da API
meu-projeto/
├── ... # configuração e arquivos do projeto
└── README.md
# Clone o repositório
git clone https://github.com/MoisesLimaJr/SWAGGER.git
# Entre na pasta do projeto
cd SWAGGER/meu-projeto
# Instale as dependências
npm install
# Inicie o servidor
node index.jsAcesse http://localhost:3000/api-docs para visualizar a documentação Swagger.
- Entendimento da arquitetura cliente-servidor via APIs REST
- Como documentar APIs de forma padronizada com OpenAPI
- Boas práticas de nomenclatura de rotas e organização de endpoints
- Base para integração entre front-end, back-end e sistemas externos (ERPs, CRMs)
Durante minha experiência em backoffice corporativo, trabalhei diariamente com sistemas integrados via API (ERP TOTVS, SAP MM, Zoho CRM, D4Sign). Este estudo me ajuda a entender tecnicamente como essas integrações funcionam por baixo dos panos.
Moises Lima Jr
- GitHub: @MoisesLimaJr
- LinkedIn: linkedin.com/in/moises-lima-jr
- Estudante de Análise e Desenvolvimento de Sistemas — Universidade Cruzeiro do Sul