Para que a API seja fácil de compreender, implementar e manter, a documentação de qualidade é importante. Nós configuramos a geração automática de documentação baseada em especificações OpenAPI com Swagger UI e Redoc, duas das ferramentas mais populares de visualização da API.
Isso permite aos desenvolvedores fornecer uma interface interativa onde você pode explorar a estrutura dos métodos, testar os pedidos e se conectar rapidamente à sua API.
O que está incluído na documentação
| Partição | Descrição |
|---|---|
| Endpoint's e métodos | Lista completa de rotas, métodos HTTP, parâmetros, cabeçalhos |
| Exemplos de solicitação/resposta | Cenários para curl, postman, JavaScript, Python e outros idiomas |
| Autorização | Suporte a JWT, OAuth2, API Key diretamente da interface |
| Esquemas de objetos | Descrição de modelos, estruturas aninhadas e requisitos de dados |
| Códigos de erro | Todos os estados com explicações possíveis |
Ferramentas que usamos
Swagger UI - documentação interativa no navegador, com capacidade de teste
Redoc - uma interface de leitura, estática, ideal para publicar no site
OpenAPI 3. 0/3. 1 - o formato da especificação a partir da qual tudo é construído
Geração automática a partir do código - anotação, descrição, versão e atualização da documentação automaticamente
Exportar para JSON/YAML/HTML
Vantagens para equipe e parceiros
Agilizar o desenvolvimento de novos desenvolvedores
Redução do número de erros de integração
Documentação sempre atualizada, sincronizada com código
Iniciar a integração rapidamente sem suporte técnico
Fácil publicar documentação em portais públicos ou privados
Onde é particularmente importante
API aberta para desenvolvedores externos
API interna em desenvolvimento ativo
Plataformas com integração B2B e SDK
Serviços exigindo regulamento e validação de esquemas
Swagger e Redoc são o padrão de documentação API de nova geração. Nós ajustaremos a geração, atualização e publicação da documentação para que qualquer desenvolvedor possa iniciar a integração com a sua API em minutos contados.