A Rest API with Dynamic Parameter Handling and Basic CRUD Operations. Implemented in Python and SQL-lite.
Setup Instructions
- Clone the repository from GitHub: git clone https://github.com/Moses-Morris/Rest-API.git
- Navigate to the project directory: cd Rest-API
- Create a virtual environment: python -m venv venv
- Activate the virtual environment:
- On macOS and Linux: source venv/bin/activate
- On Windows: venv\Scripts\activate
- Install the required packages: pip install -r requirements.txt
- Start the Flask application: python app.py or flask run
- Deployment - You can deploy the Flask application to a server of your choice.
Quick setup Overview: How to setup:
- pip install -r requirements.txt
- flask run
- Test your endpoints
- /api
- /api/<user_id>
- /api/form
Endpoints: Links: https://rest-api-aeyz.onrender.com/api
- A POST requests to https://rest-api-aeyz.onrender.com/api or https://rest-api-aeyz.onrender.com/api add information to the endpoint. The endpoint /api receives data from https://rest-api-aeyz.onrender.com/api as a POST request. The format is in raw format
- A GET requests to https://rest-api-aeyz.onrender.com/api/<user_id> Return a json object containing the details of thr user.
- A DELETE request to https://rest-api-aeyz.onrender.com/api/<user_id> Returns a msg "Delete Successful"
- A PATCH or PUT request to https://rest-api-aeyz.onrender.com/api/<user_id> Returns a json object containing the details of the user when modified and Updated.
- UML and ER Diagrams.
- UML and ER Diagrams.
Testing: Done with postman software tool. https://www.postman.com/