peacevan/api-golang-orm-swagger-docker

Repository showcasing a Go API with ORM, Swagger, and Docker. It leverages the Gin framework, GORM for ORM, and Swag for documentation. Docker streamlines development and deployment.

API in Go with ORM, Swagger and Docker

About Repository showcasing a Go API with ORM, Swagger, and Docker. It leverages the Gin framework, GORM for ORM, and Swag for documentation. Docker streamlines development and deployment.

Requirements:

Develop an API in Go using an ORM (Object-Relational Mapping) for interaction with the database, where it will be possible to perform CRUD (Create, Read, Update, Delete) operations on the entities Client, Product, Order, and OrderItem. The API should be documented using Swagger to facilitate understanding and integration by developers. Additionally, the system should be containerized using Docker to ensure portability and ease deployment in different environments.

Adjustments and improvements

The project is still under development and the next updates will be detailed in the following tasks: Create a small goang + Angular app for orders management

API implementation

• Create rotes(restFull)
• Configuration package configuration
• Add ORM
• Add swagger API documentation
• API dockerization
• Connect API in Postgresql

Front-end Implementation with Angular

• List orders in a table
• Add pagination (10 orders/page)
• Allow users to cancel an order (persist the change in db)
• Allow users to search for orders by customer or status

💻 Prerequisites

Before you begin, make sure you've met the following requirements:

• You have installed the latest version of go1.22.2
• You have a <Windows/Linux/Mac> machine.
• You have read <guide/link/documentation_related_to_project>.

🚀 Instalando

Para instalar o , follow these steps:

Linux e macOS:

DOCKER

install swag

go get -u github.com/swaggo/swag/cmd/swag

<api-golang-orm-swagger-docker>

Windows:

<api-golang-orm-swagger-docker>

☕ Usando

to use ,follow these steps:

consuming the API

Swaggaer

Insominia

📫 Contribuindo para

To contribute to, siga estas etapas:

1. Fork this repository.
2. Create a branch: git checkout -b <branch_name>.
3. Make your changes and commit them: git commit -m '<mensagem_commit>'
4. Push to the original branch: git push origin <api-golang-orm-swagger-docker> / <local>
5. Create the pull request.

Alternatively, see the GitHub documentation at how to create a pull request.

🤝 Colaboradores

😄 Become one of the contributors

Do you want to be part of this project? Click HERE and read how to contribute

📝 License

This project is under license. See the LICENSE file for more details.

⬆ Back to top