/Student-Management-API

A simple student management REST API built with the restx framework

Primary LanguagePythonMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn Twitter

Student Management API

Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About Student Management API
  2. What I Learnt
  3. How to Use
  4. License
  5. Contact
  6. Acknowledgments

About Student Management API

Student Management API, as the name implies, is a REST-API that allows schools create accounts for students and administrators to manage students data. It is hosted by the PythonAnywhere web hosting service and built with the Flask-RESTX framework.

This project allows for CRUD operations, and comes with Swagger UI for easy testing and implementation. Also, administrators have full access, whereas students have limited access for some features and can only view some others with this application.

Student Management API was built by Chumzine, with knowledge from the Backend Engineering live classes for Python by AltSchool Africa.

(back to top)

Built With

  • Python
  • Flask
  • SQLite

(back to top)

What I Learnt

This project helped me hone and practice my knowledge in the following:

  • Python
  • Flask-RESTX
  • Routing
  • Database Management
  • Debugging
  • Authentication
  • Authorization
  • API Development for Python
  • API Deployment with PythonAnywhere
  • Internet security

back to top

How to Use

To run this application, follow these steps:

  1. Open this link on your browser, https://chumzine.pythonanywhere.com

  2. Create an admin or student account; To create an 'admin' account: Click on the 'auth' panel to open up a dropdown menu of routes, then click on the route that states 'Register a user' To create a 'student' account: Click on the 'user' panel to open up a dropdown menu of routes, then click on the route that states 'Create a student'

  3. Go to the 'Login' route on the 'auth' panel to generate a token for authorisation. Copy the token (without the quotation marks)

  4. Scroll to the top of the page and click on the 'Authorize' tab on the right side. Paste the copied token in the 'Value' box, as such:

    Bearer <token>

  5. Click on the 'Authorize' tab, then the 'Close' tab

  6. You can now access any route, either as a student or an admin

  7. Once you are done with the routes, scroll back up to the top and click on the 'Authorize' tab on the right side. Click on the 'Logout' tab

Sample


Student Management API Screenshot 1



Student Management API Screenshot 2



Student Management API Screenshot 3


(back to top)

License

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

(back to top)

Contact

Adaobi Chuma-Okeke - @twitter_handle - chumzine@gmail.com

Project Link: https://github.com/Chumzine/Student-Management-API

(back to top)

Acknowledgments

(back to top)