coffee-manager

module

v0.0.0-...-10eab65 Latest Latest Go to latest Published: Jan 2, 2024 License: MIT

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

A sweet and simple CRUD API for coffee lovers like you and me.

Clone the project

  git clone https://github.com/abhinavthapa1998/coffee-manager.git

Start the server

  make run

Stop the server

  make stop

Build the binary

  make build

  GET /api/v1/coffees/coffee

  POST /api/v1/coffees/coffee/{id}

Parameter	Type	Description
`id`	`string`	Required. id of the coffee

  POST /api/v1/coffees/coffee

Parameter	Type	Description
`name`	`string`	Required. name of the coffee
`image`	`string`	Required. image of the coffee
`region`	`string`	Required. region of the coffee
`roast`	`string`	Required. roast of the coffee
`price`	`number`	Required. price of the coffee (in cents)
`grind_unit`	`string`	Required. grind_unit of the coffee

  PUT /api/v1/coffees/coffee/{id}

Parameter	Type	Description
`name`	`string`	Optional. name of the coffee
`image`	`string`	Optional. image of the coffee
`region`	`string`	Optional. region of the coffee
`roast`	`string`	Optional. roast of the coffee
`price`	`number`	Optional. price of the coffee (in cents)
`grind_unit`	`string`	Optional. grind_unit of the coffee

  DELETE /api/v1/coffees/coffee/{id}

Parameter	Type	Description
`id`	`string`	Required. id of the coffee