chisomd90/person-api

An API capable of performing CRUD operations

Person API

The Person API is a simple RESTful API that allows you to perform CRUD (Create, Read, Update, Delete) operations on person records. This README provides instructions on setting up, running, and using the API.

Table of Contents

• Prerequisites
• Getting Started
  • Installation
  • Configuration
• Running the API
• API Endpoints
  • Create a Person
  • Retrieve a Person
  • Update a Person
  • Delete a Person
• Testing the API
• Contributing
• License

Prerequisites

Before you begin, ensure you have the following:

• Python 3.10+
• pip (Python package manager)
• Flask
• Flask-SQLAlchemy
• [SQLite] (or an alternative database, based on your choice)

Getting Started

Installation

1. Clone this repository to your local machine: git clone https://github.com/yourusername/person-api.git ------- Navigate to the project directory:

cd person-api ------- Install the required Python packages: pip install -r requirements.txt

Running the API

Ensure your database is set up and running.

Run the following command to create the database tables:

python app.py -------- The API should now be running locally at http://localhost:5000.

API Endpoints

Create a Person

Endpoint: POST /api

Description: Create a new person with the given name.

Request Body: JSON data containing person details (name, age, email).

Example Request: curl -X POST http://localhost:5000/api -H "Content-Type: application/json" -d

'{
"name": "Chisom Daniel"
}'

Retreive all persons

Endpoint: GET /api/

Description: Retrieve details of all persons in the database.

Example Request: curl http://localhost:5000/api/

Retreive a person

Endpoint: GET /api/int:user_id

Description: Retrieve details of a person with the given user id.

Example Request: curl http://localhost:5000/api/int:user_id

Update a person

Endpoint: PUT /api/int:user_id

Description: Update details of a person with the given name. Request Body: JSON data containing updated person details (age, id, email).

Example Request: curl -X PUT http://localhost:5000/api/int:user_id -H "Content-Type: application/json" -d

'{
    "name": "john doe",
    "id": <int:user_id>
 }'

Delete a person

Endpoint: DELETE /api/int:user_id

Description: Delete a person with the given name.

Example Request: curl -X DELETE http://localhost:5000/api/int:user_id,

Testing the API

You can use Postman or a testing framework (e.g., pytest) to test the API. Detailed instructions for testing the API can be found in the Testing the API section of the README.

Contributing

If you'd like to contribute to this project, please follow the guidelines in CONTRIBUTING.md.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.