Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/guilhermee-ds/golang-crud

This project is a sophisticated implementation of an API, developed using the GoLang programming language. The API is encapsulated in a Docker environment, thus ensuring portability and replicability of the execution environment. In addition, this project uses PostgreSQL as a database management system, providing robust and efficient.
https://github.com/guilhermee-ds/golang-crud

api docker docker-compose dockerfile golang postgresql

Last synced: 2 days ago
JSON representation

This project is a sophisticated implementation of an API, developed using the GoLang programming language. The API is encapsulated in a Docker environment, thus ensuring portability and replicability of the execution environment. In addition, this project uses PostgreSQL as a database management system, providing robust and efficient.

Awesome Lists containing this project

README

        

# API COM DOCKER, GOLANG E POSTGRESQL

Este projeto é uma API em GoLang, encapsulada em Docker para portabilidade e replicabilidade. Utiliza PostgreSQL para um armazenamento de dados robusto e eficiente. É uma solução poderosa e escalável.

## Dependencias

- Docker
- Docker-Composer
- Golang >= go1.22.1
- PostgreSQL

####

## Como Rodar

Depois de ter todas a dependências informadas anteriormente

Inicie o container

```shell
docker compose up
```

### criar um usuário

```http
POST /users
```

| Parâmetro | Tipo | Descrição |
| :-------- | :------- | :--------------- |
| `name` | `string` | **Obrigatório**. |
| `email` | `string` | **Obrigatório**. |

#### Retorna um usuário

```http
GET /users/{id}
```

| Parâmetro | Tipo | Descrição |
| :-------- | :------- | :--------------------------------------------- |
| `id` | `string` | **Obrigatório**. O ID do usuario que você quer |

#### Retorna todos os usuários

```http
GET /users
```

#### Deletar usuário

```http
DELETE /users/{id}
```

| Parâmetro | Tipo | Descrição |
| :-------- | :------- | :----------------------------------------------------- |
| `id` | `string` | **Obrigatório**. O ID do usuario que você quer deletar |

#### Atualizar um usuário

```http
PUT /users/{id}
```

| Parâmetro | Tipo | Descrição |
| :-------- | :------- | :------------------------------------------------------- |
| `id` | `string` | **Obrigatório**. O ID do usuario que você quer atualizar |