Table of Contents
PizzaAPI is an API built on Flask-RESTX framework and properly documented in swagger UI. This API consists of various endpoints such as authentication, signup, retrieving all orders etc.
This pizza delivery API was built by Daniel Tunwashe during Backend Engineering live classes at AltSchool Africa.
Creating this API helped me learn and practice:
- API Development
- App Deployment with Heroku
- Testing
- Documentation
- Debugging
- Routing
- Database Management
- Internet Security
- User Authentication
- User Authorization
- Swagger UI Documentation
To use this API, follow these steps:
-
Open the Heroku app on your browser: https://flask-pizza-delivery-api-app.herokuapp.com/
-
Click 'auth' to reveal a dropdown menu of authentication routes
-
Register via the '/auth/signup' route, if you are a new user
-
Sign in via the '/auth/login' route to generate a JWT token. Copy this access token without the quotation marks
-
Scroll up to click "Authorize" at top right. Enter the JWT token in the given format, for example:
Bearer this1is2a3rather4long5hex6string -
Click 'Authorize' and then 'Close'
-
Now authorized, you can create, view, update and delete orders via the many routes in 'orders'
-
When you're done, click 'Authorize' at top right again to then 'Logout'
Distributed under the MIT License. See LICENSE for more information.
Daniel Tunwashe - @danielTunwashe - [email protected]
Project Link: PizzaAPI
This project was made possible by: