Skip to content
This repository has been archived by the owner on Mar 15, 2023. It is now read-only.

Change endpoints docs #22

Open
3 tasks
BrunaNayara opened this issue Oct 10, 2020 · 0 comments
Open
3 tasks

Change endpoints docs #22

BrunaNayara opened this issue Oct 10, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request Hacktoberfest 🍺

Comments

@BrunaNayara
Copy link
Contributor

BrunaNayara commented Oct 10, 2020

Problema / Problem

🇧🇷 Atualmente, os docs da api são feitos com uma biblioteca de docs do Django Rest Framework. Parece que ela não suporta muita coisa e achamos que mudar é uma boa.
Abaixo tem um screenshot da página de docs, que pode ser acessada localmente através do endpoint http://localhost:8000/docs/ quando a api está rodando.

🇬🇧 Currently, the api docs are based on a docs lib of the Django Rest Framework. It seems it does not support a few things and we are thinking of changing it.
Below there is a screenshot of the docs page. You can access it on http://localhost:8000/docs/ when the api is up on your computer.

Screenshot of the docs

Sugestão de solução

🇧🇷 A ideia é usar o swagger pra documetnar os endpoints.
🇬🇧 The idea is to use swagger.

Tarefas

  • Configurar o swagger
  • Colocar os endpoints disponíveis com exemplos
  • Remover a lib atual e tudo que a utiliza

Usem o espaço da issue para discutir sobre as soluções

@BrunaNayara BrunaNayara added documentation Improvements or additions to documentation enhancement New feature or request Hacktoberfest 🍺 labels Oct 11, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request Hacktoberfest 🍺
Projects
None yet
Development

No branches or pull requests

1 participant