This project is a marvel snap API to manage cards built using Golang. The API is powered by Go-Gin as a router, GoORM for database communication, SQLite as the database, and Swagger for API documentation.
- Introduction to Golang and building modern APIs
- Development environment setup for creating the API
- Using Go-Gin as a router for route management
- Implementing SQLite as the database for the API
- Using GoORM for communication with the database
- Integrating Swagger for API documentation and testing
- Creating a modern package structure for organizing the project
- Implementing a complete card manage API with endpoints for searching, creating, editing, and deleting cards
You can check the documentation and perform tests to the API by visiting the live version hosted at here.
To use this project, you need to follow these steps:
- Clone the repository:
git clone https://github.com/rodrigofmeneses/cosmic-snap.git - Install the dependencies:
go mod download - Build the application:
go build - Run the application:
./main
The project includes a Makefile to help you manage common tasks more easily. Here's a list of the available commands and a brief description of what they do:
make run: Run the application without generating API documentation.make run-with-docs: Generate the API documentation using Swag, then run the application.make build: Build the application and create an executable file namedcosmic-snap.make docs: Generate the API documentation using Swag.make clean: Remove thecosmic-snapexecutable and delete the./docsdirectory.
To use these commands, simply type make followed by the desired command in your terminal. For example:
make runThis project uses the following tools:
- Golang for backend development
- Go-Gin for route management
- GoORM for database communication
- SQLite as the database
- Swagger for API documentation and testing
After the API is running, you can use the Swagger UI to interact with the endpoints for searching, creating, editing, and deleting cards. The API can be accessed at http://localhost:$PORT/swagger/index.html.
Default $PORT if not provided=8080.
This project was inspired by arthur404dev.
Original video.