Documentar endpoints legados da api isus com Swagger

[ClarisCaval]

Objetivo

Como pessoa desenvolvedora
Quero realizar a documentação dos endpoints da API iSUS
Para disponibilizar a documentação dos endpoints no projeto para que demais desenvolvedores possam ter o conhecimento da estrutura de nossa API e consigam contribuir com o projeto

Contexto

O iSUS possui uma API com alguns endpoints que através deles conseguimos implementar nossas funcionalidades e realizar a comunicação e integração com alguns sistemas.

Com isso, uma boa prática de desenvolvimento ao se utilizar a estrutura de API é a documentação desses endpoints explicitando na documentação quais os retornos e seus códigos https de sucesso, quais as possíveis falhas e seus respectivos códigos https, quais as URLs dos endpoints e parâmetros necessários para a realização das chamadas, autenticação e headers e os body necessários para fazer uma chamada respeitando a obrigatoriedade dos campos e seus formatos.

Escopo

• Realizar a documentação dos endpoints listados nesse arquivo no Swagger
• Ao documentar o body das chamadas, especificar cada tipo de campo, quantidade máxima de caractere aceita, se houver e obrigatoriedade
• Ao documentar as URLs dos endpoints, especificar parâmetros utilizados nas URLs
• Ao documentar as URLs dos endpoints, especificar filtros utilizados nas URLs, se houver
• Ao documentar as URLs dos endpoints, especificar os headers de autenticação da chamada
• Ao documentar as URLs dos endpoints, descrever uma breve explicação sobre do que se trata o endpoint
• Ao documentar as URLs dos endpoints, especificar os métodos disponíveis para cada endpoint
• Ao documentar as URLs dos endpoints, especificar o retorno de sucesso e seu código http
• Ao documentar as URLs dos endpoints, especificar o retorno de falha e seu código http

Critérios de Aceitação

• 1. Dado que eu acesso o swagger do projeto iSUS API
     Quando abrir uma seção de endpoint
     Então visualizarei as especificações e métodos disponíveis daquele endpoint

Links Úteis

• Arquivo com a lista de endpoints: https://drive.google.com/file/d/1HrCA9XJ9Iui3sVgdd3wb64wpCD0g4jS7/view
• Swagger: https://swagger.io/