Skip to content

vitorconti/go-products

Repository files navigation

Go Products API

This is a sample Go application for managing products. It uses a MySQL database to store the products and RabbitMQ for sending messages between components.

Requirements

Running the Application

Clone the repository:

$ git clone https://github.com/vitorconti/go-products.git
$ cd go-products-api
Start the Docker containers:

with this following command you will create the necessary containers to run the application

$ docker-compose up -d

At the first time that you run this following command, will be created the products table in the database and the seeder of this table

$ go run cmd/main.go cmd/wire_gen.go

inside of the main folder you can found a post collection with the endpoints and requests examples you can found the .env of the application inside of the project feel free to change and test

Usage The API has the following endpoints:

GET /products Returns a list of all products. This route accepts two query paramas: page and limit, the default values is 1 and 10

POST /products Creates a new product. The request body should contain JSON data with the following properties:

{
  "name": "Product Name",
  "description": "Product Description",
  "price": 10.99
}

PUT /products Updates an existing product. The request body should contain JSON data with the following properties:

{
  "id" : 10
  "name": "Product Name",
  "description": "Product Description",
  "price": 10.99
}

DELETE /products/:id Deletes an existing product.

Troubleshooting

If you encounter any issues with the application, try the following steps:

  • Make sure Docker and Docker Compose are installed correctly.
  • Check if the required ports (8080, 3306, 5672, 15672) are available on your system.
  • Restart Docker Compose with docker-compose down followed by docker-compose up.
  • If the MySQL container fails to start, delete the mysql/data directory and restart Docker Compose.

License This application is open source software licensed under the MIT License. See the LICENSE file for more information.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published