The recipe service contains and holds all endpoints related to managing and creating recipes. Below is a list of all recorded endpoints and their HTTP verbs
- CATEGORIES
- Crud operation for recipe categories
- RECIPES
- Crud operation for recipes
- INGREDIENTS
- Crud operation for ingredients
- Golang
- MysQL
- Gorillar Mux
- Glide
- Docker
| verbs | endpoints | description |
|---|---|---|
| GET | /recipes | Get all recipes |
| POST | /recipes | Creates new recipe |
| PATCH | /recipes/ | Updates a recipe |
| DELETE | /recipes/ | Deletes a recipe |
| GET | /recipes/ | Gets a single recipe |
| GET | /categories | Gets all categories |
| POST | /categories | Creates a new category |
| PATCH | /categories/ | Updates a category |
| DELETE | /categories/ | Deletes a category |
| GET | /categories/ | Gets a single category |
| GET | /categories//recipes | Gets all recipe that belongs to a category |
| GET | /categories?q={query} | Searches for categories |
| GET | /categories?limit={limit} | Limits categories |
| GET | /categories?page={offset} | paginates categories |
| GET | /ingredients | Gets all ingredients related to recipe |
| GET | /ingredients | Gets all ingredients |
| POST | /ingredients | Creates new ingredients |
| PATCH | /ingredients/ | Updates an ingredient |
| DELETE | /ingredients/ | Deletes an ingredient |
| GET | /ingredients/ | Gets a single ingredient |
| GET | /ingredients?q={query} | Searches for ingredients |
| GET | /ingredients?limit={limit} | limits search result |
| GET | /ingredients?offset={offset} | paginates result set |
You can get all endpoints directly on you postman collection by clicking on the link below
- Clone repository
- Cd into the recipe folder
- run docker-compose build
- run docker-compose up
- make your API calls to localhost:8080/api/v1/recipes
- Fork repo to your branch
- Clone the repo
- Add a feature and raise a PR to the base branch
- PR is reviewed and merged