Documentação de API com ChatGPT

Diferentes formatos de documentação usando o ChatGPT

Essa parte eu diria que foi a mais impressionante pelo potencial que consegui observar (aqui é o humano escrevendo novamente). Eu busquei gerar alguns formatos de documentação e vou apresentar abaixo o resultado de cada um deles e como foi simples solicitar ao ChatGPT (não foi de primeira, mas foi bem rápido se considerar que isso toma tempo no dia a dia).

Documentação Markdown sobre os recursos da API

Se você observar na imagem, verá que fiz 3 alterações (lado superior esquerdo) no texto para conseguir o resultado que eu precisava.



Documentação no formato OpenAPI

Essa documentação foi relativamente simples pois apenas pedi uma "documentação no formato openapi para o código abaixo (e colei o código)". Deu certo e sem surpresas.

Documentação com as regras de negócio

Ta certo que a API é bem simples, mas isso é meio chato da fazer, porém importante. E pedir uma lista para o ChatGPT como as regras de negócio também foi algo bem simples e sem dificuldades de conseguir o que eu estava buscando.