Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add swagger documentation #19

Merged
merged 3 commits into from
Jul 23, 2024

Conversation

vitorAzevedo09
Copy link
Contributor

@vitorAzevedo09 vitorAzevedo09 commented Jul 20, 2024

Descrição

Este pull request introduz documentação swagger nos endpoints do projeto, por meio da utilização do módulo gin-swagger.

Mudanças Realizadas

  1. Adição de dependencias:

    • Adicionado as dependências :
      - github.com/swaggo/gin-swagger
      • github.com/swaggo/files.
  2. ** Adição de comentários nas funções handlers**

  3. ** Adição de configurações no arquivo http.go**

Arquivos Modificados

  • ./README: atualização da documentação.
  • ./go.mod: adição de modulo.
  • ./go.sum`: adição de módulo.
  • pkg/handlers/handlers.go: Adição de modelo ErrorResponse e comentários para geração da documentação swagger.
  • pkg/http/http.go: Adição da configuração das rotas e arquivos swagger

Mudanças Detalhadas

  • Tamanho da Fonte do Código de Erro:
    • Adicionada a classe CSS .error-code com font-size: 4rem; para aumentar o tamanho da fonte do código de erro.
  • Tamanho da Fonte da Mensagem de Erro:
    • Adicionada a classe CSS .error-message com font-size: 1.5rem; para aumentar o tamanho da fonte da mensagem de erro.
  • Alinhamento Central:
    • Aplicada a classe text-center do Tailwind CSS para centralizar o texto dentro do contêiner.

Como Isso Foi Testado?

  • Testado manualmente a página de documentação.

Issue Relacionada

Tipos de Mudanças

  • Correção de bug (mudança que não quebra a compatibilidade e corrige um problema)
  • Nova funcionalidade (mudança que não quebra a compatibilidade e adiciona uma funcionalidade)
  • Mudança que quebra a compatibilidade (correção ou funcionalidade que causa uma mudança em funcionalidades existentes)

Checklist

  • Meu código segue o estilo de código deste projeto.
  • Minha mudança requer uma mudança na documentação.
  • Eu atualizei a documentação conforme necessário.
  • Eu adicionei testes para cobrir minhas mudanças.
  • [ x] A atualização exige apenas testes manuais
  • Todos os novos e antigos testes passaram.

Notas Adicionais

@vitorAzevedo09 vitorAzevedo09 marked this pull request as draft July 20, 2024 15:07
@vitorAzevedo09 vitorAzevedo09 marked this pull request as ready for review July 20, 2024 15:08
@mffonseca mffonseca merged commit 349af10 into dedevpradev:main Jul 23, 2024
1 check passed
@mffonseca mffonseca linked an issue Jul 28, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adicionar Configuração para swagger
2 participants