Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/matheusgb/library

📚 | API de gerenciamento de livraria.
https://github.com/matheusgb/library

docker go golang postgresql viper

Last synced: 2 days ago
JSON representation

📚 | API de gerenciamento de livraria.

Awesome Lists containing this project

README 

        
# LibraryInGo



CRUD desenvolvido para o desafio técnico da Taghos. Nessa aplicação é possível cadastrar, editar, excluir e listar livros.



## 🚀 Começando



Essas instruções permitirão que você obtenha uma cópia do projeto em operação na sua máquina local para fins de desenvolvimento e teste.



## 🔧 Instalação



1. Clone o repositório e entre na pasta:



```

git clone [email protected]:matheusgb/crud-library.git && cd crud-library

```





2. Renomeie os arquivos `config.toml.example` e `.env.example` para `config.toml` e `.env`







3. Rode o comando:

```

docker compose up -d --build

```







4. E inicialize a aplicação Golang:

```

go run main.go

```

## 📌  Rotas e retornos dos endpoints



`GET /` - lista todos os livros 



*Retorno:*

```

[

	{

		"id": 1,

		"title": "Título Genérico",

		"category": "Romance",

		"author": "Value Man",

		"synopsis": "Um livro com sinopse"

	},

	{

		"id": 2,

		"title": "Outro Título",

		"category": "Fantasia",

		"author": "Homem Valor",

		"synopsis": "Outro livro com sinopse"

	}

]

```

#



`GET /{id}` - lista o livro do id correspondente



*Retorno:*

```

{

	"id": 1,

	"title": "Título Genérico",

	"category": "Romance",

	"author": "Value Man",

	"synopsis": "Um livro com sinopse"

}

```

#



`POST /` - adiciona um livro



*Corpo esperado na requisição:*

```

{	

	"title": "Título Qualquer",

	"category": "Aventura",

	"author": "Autor desconhecido",

	"synopsis": "Um livro misterioso"

}

```



*Retorno:*

```

{

	"Error": false,

	"Message": "Book inserted! ID: 3"

}

```

#



`PUT /{id}` - edita um livro pelo id



*Corpo esperado na requisição:*

```

{	

	"title": "Título editado",

	"category": "Fantasia",

	"author": "Autor editado",

	"synopsis": "Um livro editado"

}

```



*Retorno:*

```

{

	"Error": false,

	"Message": "Successfully updated!"

}

```



#



`DELETE /{id}` - deleta um livro pelo id



*Retorno:*

```

{

	"Error": false,

	"Message": "Successfully deleted!"

}

```



## 🖇️ Considerações sobre o projeto



Primeiramente gostaria de agradecer ao Leonardo Magalhães e ao Christian Bittencort pela oportunidade de realizar esse desafio para a Taghos, gostei muito de desenvolver em Golang e do clima da conversa que tivemos, espero que eu atenda as expectativas para que ambos fatores se tornem rotineiros 😁.



#



### Sobre o desenvolvimento



Foram três dias de desenvolvimento e minha primeira vez lidando com Golang e Postgres.

No desafio havia a possibilidade de escolher um banco de dados SQL (Postgres) ou noSQL (MongoDB), optei pela primeira opção devido a afinidade com MYSQL que desenvolvi durante estudos na Trybe. MongoDB ainda estou aprendendo.



Durante a execução do projeto aprendi bastante, nos primeiros dias de desenvolvimento busquei entender fundamentos da linguagem Golang para conseguir compreender melhor conteúdos diversos que pesquisei enquanto me deparava com alguma dúvida.



Entendi o funcionamento do `go.mod` e consegui fazer uso de packages externos como `viper` (para setar variáveis de ambiente) e `chi` (para setar rotas da API).



Tracei algumas semelhanças de Golang com Typescript, as tipagens, funções e interfaces funcionam de formas semelhantes, isso trouxe certo conforto e melhor entendimento durante o projeto.



Ter utilizado o `docker-compose` para criar o banco de dados, tabelas e popular as mesmas, facilitou muito desenvolvimento.



#



### Pontos de melhoria



Por se tratar do primeiro contato com a liguagem e poucos dias de estudo, ainda há conceitos que não entendi completamente como aplicar:

* Ponteiros

* Arquitetura

* Clean code 

* Tratamento de erros

* Implementação de http codes no retorno dos endpoints



E no futuro, prentendo adicionar documentação `Swagger` a aplicação.

#



### Dificuldades encontradas



Busquei fazer o uso somente do `.env`, porém tive dificuldades em sua impletementação no `viper`, então segui um tutorial que usava o `.toml` e deixei o `.env` unicamente para o `docker-compose`.



Me deparei com um bug no `main.go`. Quando tentava inicializar a aplicação com `go run main.go`, ela quebrava e não demonstrava erro algum. Depois de horas descobri que foi um `:` que esqueci de colocar no `ListenAndServe`.



---

Desenvolvido por [Matheus Gomes](https://www.linkedin.com/in/matheusgb/)