Especificações de documentação

Um conjunto de regras que vaõ guiar o processo de documentar a API.

  • Descrição da funcionalidade;

  • Parâmetros de entrada utilizados;

  • Formato da requisição/resposta;

  • Status code esperado;

  • Requerimento ou não de autenticação.

Quando falamos de REST API, a principal especificação é o OpenAPI.

Aprenderemos a frente sobre Swagger e Readme.

Atualizado