golang-web-api-structure

module
v0.0.0-...-bdedfc3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 10, 2022 License: MIT

README

��

Golang Web Api Structure


Este projeto � um microframework de aplica��o web com sintaxe expressiva e elegante. Ao utilizar a estrutura deste projeto voc� elimina a dor do desenvolvimento facilitando tarefas comuns usadas em muitos projetos da web, como:

  • Servi�o de inje��o de depend�ncia
  • Database ORM
  • Gerenciamento de rotas
  • Autentica��o com JWT
Requisitos

O framework Laravel possui alguns requisitos:

  • Go 1.18
  • Docker
Instala��o

A maneira recomendada de instalar este projeto � seguindo estas etapas:

  1. Realize o clone do projeto para a sua m�quina
git clone git@github.com:ReinanHS/golang-web-api-structure.git
  1. Acessar as pastas do projeto
cd golang-web-api-structure
cp .env.example .env
make up
make server
Software stack

Esse projeto roda nos seguintes softwares:

  • Git 2.33+
  • Go 1.18
  • Gin
  • Gorm
Routing

As rotas aceitam um URI e um encerramento, fornecendo um m�todo muito simples e expressivo de definir rotas e comportamento sem arquivos de configura��o de roteamento complicados.

Para voc� definir uma nova rota voc� deve editar o seguinte arquivo: internal/http/config/route.go

func AddRoutes(ctx context.Context, router *gin.Engine) *gin.Engine {

	// Adicione suas rotas aqui
	router.GET("/", user.NewUserController(ctx).Index)
	
	return router
}
Changelog

Por favor, veja CHANGELOG para obter mais informa��es sobre o que mudou recentemente.

Seja um dos contribuidores

Quer fazer parte desse projeto? Clique AQUI e leia como contribuir.

Seguran�a

Se voc� descobrir algum problema relacionado � seguran�a, envie um e-mail para reinangabriel1520@gmail.com em vez de usar o issue.

Licen�a

Esse projeto est� sob licen�a. Veja o arquivo LICEN�A para mais detalhes.

Directories

Path Synopsis
cmd
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag
internal
pkg
dto

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL