Skip to content

This is a simple Pizza API built with Flask, SQLAlchemy, pytest, and python-decouple. The API allows customers to create orders and also allows the delivery of orders

Notifications You must be signed in to change notification settings

Jessica-ovabor/JessiPizzaApi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License Twitter


JessiPizzaApi


Table of Contents
  1. About JessiPizzaApi
  2. Lessons Learned
  3. Usage
  4. Sample
  5. License
  6. Contact
  7. Acknowledgements

back to top


About JessiPizzaApi

JessiPizzaApi is a RESTful API which enables users to register accounts on the pythonanywhere-powered app and place pizza orders. CRUD operations can then be carried out on these orders, with an easy-to-use Swagger UI setup for testing and integration with the front end.

This pizza delivery API was built by Jessica ovabor during Backend Engineering live classes at AltSchool Africa.

back to top

Built With:

Python Flask SQLite

back to top


Lessons Learned

Creating this API helped me learn and practice:

  • API Development
  • App Deployment with Pythonanywhere
  • Testing
  • Documentation
  • Debugging
  • Routing
  • Database Management
  • Internet Security
  • User Authentication
  • User Authorization

back to top


Usage

To use this API, follow these steps:

  1. Open the Python anywhere app on your browser: https://jessyspace.pythonanywhere.com

  2. Click 'auth' to reveal a dropdown menu of authentication routes

  3. Register via the '/auth/signup' route, if you are a new user

  4. Sign in via the '/auth/login' route to generate a JWT token. Copy this access token without the quotation marks

  5. Scroll up to click "Authorize" at top right. Enter the JWT token in the given format, for example:

    Bearer this1is2a3rather4long5hex6string
    
  6. Click 'Authorize' and then 'Close'

  7. Now authorized, you can create, view, update and delete orders via the many routes in 'orders'

  8. When you're done, click 'Authorize' at top right again to then 'Logout'

back to top


Sample


JessiPizzaApi


back to top


License

Distributed under the MIT License. See LICENSE for more information.

back to top


Contact

Jessica Ovabor - @jovabor - [email protected]

Project Link: JessiPizzaApi

back to top


Acknowledgements

This project was made possible by:

back to top


About

This is a simple Pizza API built with Flask, SQLAlchemy, pytest, and python-decouple. The API allows customers to create orders and also allows the delivery of orders

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published