Go API é um projeto de exemplo de uma API RESTful em Go. Ele utiliza o framework Gin para tratar requisições HTTP e a biblioteca GORM para interagir com o banco de dados.
Para executar o projeto, siga os passos abaixo:
- Clone este repositório para sua máquina local
- Certifique-se de que o Go está instalado em sua máquina
- Configure as variáveis de ambiente no arquivo
.env
(exemplo fornecido em.env.example
) - Execute o comando
go run cmd/main.go
O servidor será iniciado em http://localhost:8080.
Utilize esse comando para iniciar o banco com o docker
docker run -d --name postgresql -e POSTGRESQL_PASSWORD=user -e POSTGRESQL_USERNAME=password -e POSTGRESQL_DATABASE=go-api -p 5432:5432 bitnami/postgresql:latest
A API oferece os seguintes endpoints:
Endpoint responsável por registrar um novo usuário na aplicação.
Requisição:
{
"email": "email@example.com",
"password": "123456"
}
Resposta:
{
"status": "success",
"message": "User created successfully"
}
Endpoint responsável por autenticar um usuário na aplicação.
Requisição:
{
"email": "email@example.com",
"password": "123456"
}
Resposta:
{
"status": "success",
"message": "Logged in successfully",
"data": {
"user_id": 1,
"access_token": "<jwt-token>"
}
}
Endpoint de teste.
Resposta:
{
"status": "success",
"message": "API is working"
}
A estrutura do projeto é baseada no padrão MVC. O diretório api
contém o código relacionado à API. O diretório config
contém configurações da aplicação e o arquivo config.database
contém o código relacionado ao banco de dados.