The Person API allows you to manage and retrieve information about a person, including their name, age, and email addresse.
Follow the instructions below to get the Person API up and running on your local machine.
- Python 3.9 or higher
- Django 3.2 or higher
- Django REST Framework 3.12 or higher
- Clone the repository:
git clone https://github.com/your-username/person-api.git
- Change into the project directory:
cd person-api
- Create and activate a virtual environment:
hange into the project directory:
python3 -m venv venv source venv/bin/activate
- Install the required dependencies:
pip install -r requirements.txt
- Apply database migrations:
python manage.py migrate
- Run the following command to start the API:
python manage.py runserver
- The API will be accessible at https://endpoint-dez.onrender.com/api/
- POST /api/: Creates a new person.
- GET /api/{id}/: Retrieves a specific person by their id.
- PUT /api/{id}/: Updates an existing person.
- DELETE /api/{id}/: Deletes a person.
Please refer to the API documentation or interact with the API using tools like Postman to explore these endpoints in detail. Use this to link to access the test script on postman: https://documenter.getpostman.com/view/25680408/2s9YC1XuMF
- Lastly, images for the UML and ER Diagram are in root directory with the base name
person