Table of Contents
AltSchool Pizza is a RESTful API which enables users to register accounts on the Heroku-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 Ze Austin 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
To use this API, follow these steps:
-
Open the Heroku app on your browser: https://altschool-pizza.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.
Dr Austin Wopara - @Ze_Austin - austinwopara@gmail.com
Project Link: AltSchool Pizza
This project was made possible by: