davidambz / gym-api

Golang API to gym workout
0 stars 0 forks source link

Documentar Endpoints de Treinos (Workouts) #33

Open davidambz opened 3 months ago

davidambz commented 3 months ago

Documentar Endpoints de Treinos (Workouts)

Descrição: Precisamos documentar todos os endpoints relacionados a treinos (workouts). A documentação deve ser criada utilizando Swagger e deve incluir todos os detalhes necessários para descrever cada endpoint, como parâmetros de entrada, métodos HTTP suportados, modelos de resposta e exemplos de solicitação e resposta.

Ações sugeridas:

  1. Revisar endpoints existentes: Identificar todos os endpoints relacionados a treinos que precisam de documentação.
  2. Criar a documentação: Utilizar Swagger para descrever cada endpoint, incluindo parâmetros, respostas e exemplos.
  3. Testar a documentação: Garantir que a documentação gerada esteja correta e reflita com precisão a funcionalidade dos endpoints.

Benefícios:

Pré-requisitos: