DEV Community

Anderson Contreira
Anderson Contreira

Posted on

Você criou uma API, mas não tem documentação? Eita... 😅

Se você desenvolveu uma API e ela não tem documentação, temos um problema.
No mínimo, você deveria conseguir exportar uma collection (Postman, Insomnia etc.) e deixá-la em uma pasta dentro do repositório. Isso facilita demais a vida dos coleguinhas devs que vão precisar testar, debugar ou integrar com a sua API.

E quer saber o que é ainda melhor?
Ter um endpoint com a documentação da API, por exemplo, usando Swagger.
Isso é uma mão na roda e, sinceramente, deveria ser obrigatório por padrão.

Não é difícil de implementar e traz muitos benefícios, desde a comunicação entre times até o onboarding de novos desenvolvedores.
Dependendo da linguagem e biblioteca, você consegue gerar tudo isso com anotações no código.

Então... sem desculpas.
Documente sua API. Você (e seu time) vão agradecer depois!

Top comments (0)