Golang-API-BrStates

This is a simple example of a REST API in Go (Golang) that uses version 1.22 of Go itself to create an HTTP server and the GORM ORM to interact with a PostgreSQL database. This API will return a JSON with data about the Brazilian states according to some ID informed in the GET request: localhost:8080/api/{ID} for a specific return or localhost:8080/api/total to get all the information.

List of IDs:

1. Acre
2. Alagoas
3. Amapá
4. Amazonas
5. Bahia
6. Ceará
7. Distrito Federal
8. Espírito Santo
9. Goiás
10. Maranhão
11. Mato Grosso
12. Mato Grosso do Sul
13. Minas Gerais
14. Pará
15. Paraíba
16. Paraná
17. Pernambuco
18. Piauí
19. Rio de Janeiro
20. Rio Grande do Norte
21. Rio Grande do Sul
22. Rondônia
23. Roraima
24. Santa Catarina
25. São Paulo
26. Sergipe
27. Tocantins

Configuration

Dependencies

Make sure you have Go installed on your machine. You will also need to install the following dependency:

• GORM: Go ORM.

Database

You can set up a PostgreSQL database using Docker Compose. The docker-compose.yml file is already configured to start two services: PostgreSQL and PgAdmin.

1. Make sure you have Docker and Docker Compose installed on your machine.
2. Run the following command in the root of the project: docker-compose up

This command will start the PostgreSQL and PgAdmin services.

Access PgAdmin in your browser using the following address: http://localhost:54321

Use the email [email protected] and password admin to log in. Then, you can add a PostgreSQL server and connect to the database.

Migration Script

During the initialization of the PostgreSQL service, Docker Compose will run an SQL script located at ./migration/docker-database-initial.sql. This script is responsible for creating the necessary database and table for the application.

How to Use

1. Clone this repository to your local machine.
2. Make sure you have the GORM dependency installed.
3. Set up the Docker Compose environment as described above.
4. Run the server with the following command: go run main.go

Endpoints

1. GET /api: Returns all states in JSON format.
2. GET /api/{id}: Returns a specific state by ID in JSON format.
3. GET /api/total: Returns all states in JSON format.

Project Structure

1. config/: Contains the HTTP server configuration.
2. controllers/: Controllers to handle HTTP requests.
3. database/: Configuration and connection with the database.
4. models/: Definition of the application data models.
5. routes/: Definition of API routes.
6. main.go: Entry point of the application, where routes are loaded and the server is initialized.