go-api

README

Go API Master Example

🚧 Go API 🚀 Under construction... 🚧

---

About   |   Features   |   Technologies   |   Requirements   |   Starting   |   License   |   Author

🎯 About

This a project is a example of API Rest in Go using Gin, Gorm & PostgreSQL.
For good practies of coding i'm using Twelve Go Best Practices
For quality of code i'm using Go Report Card
For folder struct this project i'm using Standard Go Project Layout
Link for Go Report Card

✨ Features

The features of projet is

• Create User: Returns the created user.
• Update User: Returns a message indicating success or failure.
• Find All Users: Returns a list of users or an empty list if no users are found.
• Find User By ID: Returns the user if found, or an error message if not found or error.
• Delete User By ID: Returns a message indicating success or failure.

🚀 Technologies

The following tools were used in this project:

• Go
• Gin
• Gorm
• PostgreSQL

✅ Requirements

Before starting 🏁, you need to have Git and Go installed. Obs.: for PostgreSQL you can use a datababase provider, like AWS

🏁 Starting

# Clone this project
$ git clone https://github.com/LuizWetz/go-api

# Access
$ cd Go-API

# Install dependencies
$ go mod tiny

# Run the project
$ cd cmd
$ go run main.go

# The server will initialize in the <http://localhost:8080>
# The swagger docs will initialize in the <http://localhost:8080/swagger/index.html#/>

📝 License

This project is under license from MIT. For more details, see the LICENSE file.

Made with ❤ by Luiz Weitz

 

Back to top