DumpAPI is a Flask-Restful API that contains data of departments and their employees. The API utilizes token generation with JWT (JSON Web Tokens) for secure access. All the data is stored in a cloud database provided by Yugabyte, which offers a free PostgreSQL database service. The passwords are hashed and stored in the database for enhanced security.
Read Docs Generated by Postman : Read Docs
To use the DumpAPI in your system, follow the steps below:
- Create a virtual environment for the project.
- Install all the required dependencies using
pip install -r requirements.txt. - Add your
.envfile in theDumpAPIfolder, containing the following data:
DATABASE_YUGA="your database sqlalchemy uri"
ENCRYPT_KEY="your key" (for encrypting the passwords)
JWT_KEY="your key" (for encrypting the JWT token)
- Run the
run.pyfile to start the API.
This project is licensed under the MIT License. See the LICENSE file for more details.