Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alexzaitsev/recipe-api

Extended Recipe API (tags, ingredients, recipes, images, authorization) on Django REST Framework using Docker, CI and Test Driven Development approach
https://github.com/alexzaitsev/recipe-api

api django django-rest-framework docker python tdd travis-ci

Last synced: about 1 month ago
JSON representation

Extended Recipe API (tags, ingredients, recipes, images, authorization) on Django REST Framework using Docker, CI and Test Driven Development approach

Host: GitHub
URL: https://github.com/alexzaitsev/recipe-api
Owner: alexzaitsev
Created: 2019-07-02T09:37:12.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2022-04-22T21:47:11.000Z (almost 3 years ago)
Last Synced: 2024-11-09T10:10:10.115Z (3 months ago)
Topics: api, django, django-rest-framework, docker, python, tdd, travis-ci
Language: Python
Homepage:
Size: 359 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Project description

This is an extended Recipe API.
It allows to register new users, authenticate them using token generation,
retrieve or update user details.
User can operate tags, ingredients, recipes, images.
All these components allow creating a comprehensive front-end for the API.
This can be a recipe website or mobile application.

## Technical details

Website is built on the _Django 2.2_ and _Django REST Framework_.
The database is _Postgres_.
The application uses _Docker_ and _Travis-CI_ for automatic unit testing after each commit.

Project is covered with unit tests. For local API testing, I use _Postman_.
Also, the project is configured with Swagger.

## Endpoints

![swagger](screenshots/swagger.png)

## User

Default Django User model is customized to the user can log in using `email` and `password`
instead of `username` and `password`. That is mirrored in admin panel as well.

## Filtering

Tags, ingredients, and recipes can be filtered using GET query params.