fga-eps-mds / 2022-1-TiControla-FrontEnd

MIT License
2 stars 7 forks source link

Adicionar documentação Swagger ao ambiente de desenvolvimento da API #72

Closed leomichalski closed 2 years ago

leomichalski commented 2 years ago

Descrição:

A documentação do Swagger é bem boa. Só achei chato que ela não revela que um comando cURL pode ser traduzido para outras linguagens como Python, Javascript e Typescript. Também seria interessante adicionar mais informações sobre o contexto em que cada requisição HTTP foi pensada para ser chamada (o swagger não tem como saber nada sobre o frontend).

Tarefas:

Critérios de avaliação:

leomichalski commented 2 years ago

TL;DR: Não vamos mais usar o swagger por enquanto.

O repositório original do gerador automático de swagger não é mais mantido, como pode ser visto aqui: https://github.com/marcgibbons/django-rest-swagger. O repositório que está sendo mantido atualmente ainda não suporta a versão 3.13 do Django Rest Framework (DRF) (é a versão que estamos utilizando), como pode ser visto neste link. Para checar se o drf-yasg já suporta a versão 3.13 do DRF, visite este link: https://github.com/axnsan12/drf-yasg/