Table of Contents
Ze School is a REST API which enables school staff to register accounts and manage student data on the PythonAnywhere-powered web app. CRUD operations can be carried out on the student data, with an easy-to-use Swagger UI setup for testing and integration with the front end.
Students have limited access to the app, as a student can only change their profile details and view their profile, courses, grades and CGPA.
This student management API was built with Python's Flask-RESTX by Ze Austin as the third semester exam project for a Diploma in Backend Engineering from AltSchool Africa.
Creating this API helped me learn and practice:
- API Development with Python
- App Deployment with PythonAnywhere
- Testing with pytest and Insomnia
- Documentation
- Debugging
- Routing
- Database Management
- Internet Security
- User Authentication
- User Authorization
To use this API, follow these steps:
-
Open the PythonAnywhere web app on your browser: https://zeaustin.pythonanywhere.com
-
Create an admin or student account:
- Click 'admin' to reveal a dropdown menu of administration routes, then register an admin account via the '/admin/register' route
- Click 'students' to reveal a dropdown menu of student routes, then register a student account via the '/students/register' route
-
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 students, courses, grades and admins via the many routes in 'students', 'courses' and 'admin'. You can also get:
- All students taking a course
- All courses taken by a student
- A student's grades in percentage (eg: 84.8%) and letters (eg: A)
- A student's CGPA, calculated based on all grades from all courses they are taking
-
When you're done, click 'Authorize' at top right again to then 'Logout'
Note: When using this API in production, please fork this repo and uncomment the @admin_required() decorator in line 51 of the admin views file. This will ensure that students and other users will not be authorized to access the admin creation route after the first admin is registered.
Distributed under the MIT License. See LICENSE for more information.
Dr Austin Wopara - @Ze_Austin - austinwopara@gmail.com
Project Link: Ze School
This project was made possible by: