https://github.com/jhon-henkel/go_lang_api_example

Repositório com objetivo de estudar a estrutura de uma api em Go
https://github.com/jhon-henkel/go_lang_api_example

golang

Last synced: about 1 month ago
JSON representation

Repositório com objetivo de estudar a estrutura de uma api em Go

• Host: GitHub
• URL: https://github.com/jhon-henkel/go_lang_api_example
• Owner: Jhon-Henkel
• License: mit
• Created: 2023-09-11T10:16:01.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-12T22:37:03.000Z (over 1 year ago)
• Last Synced: 2023-09-13T07:42:21.850Z (over 1 year ago)
• Topics: golang
• Language: Go
• Homepage:
• Size: 29.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
No repositório abaixo tem um guia de padrão de organização do projeto que a comunidade GO utiliza como boas práticas da linguagem.

```

https://github.com/golang-standards/project-layout

```

Swagger link http://localhost:8000/docs/index.html#

Para gerar o swagger.json (rodar na raiz do projeto)

```

swag init -g cmd/server/main.go

```

A pasta internal, é somente para a sua aplicação e não deve ser compartilhada com outros projetos. Essa pasta não pode ficar disponível para outras pessoas importarem. Tudo que você não quer que seja importado por outras aplicações, deve ficar dentro dessa pasta.

A pasta pkg é o oposto da internal, tudo que você quer que seja importado por outras aplicações, deve ficar dentro dessa pasta.

A pasta cmd é onde fica o seu projeto, o build, o main.go

A pasta configs é onde vai ficar as configurações do seu projeto. Padrões do projeto, configurações de banco de dados, templates, boot da aplicação, etc.

A pasta test armazena os testes da aplicação, stubs, documentações do teste.

A pasta api tem documentações da API, swagger, openapi, etc.

O foco dessa pasta é estudar a estrutura de API com GO, a parte de domain, regras de negócio e infraestrutura não será abordada nessa etapa.