golang-api

README

GoLang API

Introduction • Installation Guide • Project Structure • API Reference • Contributing • License • Contributors

ℹ️ Introduction

• Product API for CRUD operations.
• Written in GoLang and PostgreSQL. Bearer token authentication is used.
• Database connection is made with GORM. Server is created with gorilla/mux.
• I am just making this project for learning purposes. I am open to any suggestions and contributions.
• Project can be evolved with adding new features and tests.

💾Installation Guide

• To clone and run this application, you'll need Git, Go, PostgreSQL installed on your computer. From your command line:

  # Clone this repository
  $ git clone https://github.com/Ctere1/golang-api
  # Go into cmd folder
  $ cd cmd 
  # Run the app
  $ go run main.go
  

• You can change the database connection string in the app.toml file. Also, you can change the API listen address and port.

  After these steps, you can use the API with Postman or any other API testing tool.

🗺️Project Structure

• You can take a part of it and edit it to suit your own needs and liking.

• The project structure is as follows:

  ├───cmd
  │   └───main.go
  ├───pkgs
  │   ├───api
  │   │   ├───router.go
  │   │   └───RestHandler.go
  │   ├───category
  │   │   ├───categoryApiHandler.go
  │   │   └───categoryController.go
  │   ├───configs
  │   │   └───configs.go
  │   ├───product
  │   │   ├───productApiHandler.go
  │   │   └───productController.go
  │   └───storage
  │       ├───categoryPostgres.go
  │       ├───productPostgres.go
  │       └───storage.go
  ├───app.toml
  ├───go.mod
  ├───go.sum
  ├───LICENSE
  ├───README.md
  └───postman_collection.json
  

What is the purpose of each folder and file?

• cmd folder contains the main.go file. This file is the entry point of the application.
• pkgs folder contains the application logic.
• api folder contains the router and RestHandler files. These files are used to create the server and handle the requests.
• category folder contains the categoryApiHandler and categoryController files. These files are used to handle the category requests.
• product folder contains the productApiHandler and productController files. These files are used to handle the product requests.
• storage folder contains the storage and database files. These files are used to connect to the database and make CRUD operations.
• app.toml file contains the application configurations.
• go.mod and go.sum files are used to manage the dependencies.

⚡API

[!Tip] See postman collection json for detailed information.

Product Endpoints

HTTP Verb	Endpoint	Description
GET	/api/v1/product	Returns All Products
GET	/api/v1/product/{sku}	Returns the product with {sku}
DELETE	/api/v1/product/{sku}	Deletes the product with {sku}
POST	/api/v1/product/	Creates and returns product
PUT	/api/v1/product/	Updates and returns product

[!IMPORTANT]
Product sku is unique and required.

Category Endpoints

HTTP Verb	Endpoint	Description
GET	/api/v1/category	Returns All Categories
GET	/api/v1/category/{id}	Returns the category with {id}
DELETE	/api/v1/category/{id}	Deletes the category with {id}
POST	/api/v1/category/	Creates and returns category
PUT	/api/v1/category/	Updates and returns category

[!IMPORTANT]
Category name is unique and required.

Product Data Example

{
    "Name": "test1",
    "Price": "123",
    "Description": "test desc",
    "Sku": "sku1",
    "CategoryId": "1"
}

Category Data Example

{
    "Id": "1",
    "Name": "test1",
}

🤝Contributing

• Fork the project (Fork button in the top right corner)

  • Clone it on your local machine
  • Create your feature branch (git checkout -b feature/yourFeature)
  • Commit your changes (git commit -m 'Add some yourFeature')
  • Push your branch (git push origin feature/yourFeature)
  • Open a new Pull Request

• You can also contribute to the project by opening issues.

©License

📌Contributors