Task 2 Repo

The Person Webservice is a RESTful API that allows users to interact with a Person resource. This webservice provides basic CRUD (Create, Read, Update, Delete) operations for managing Person objects.

A Person object represents an individual with a name.

• name (String, max length 100): The unique identifier of the person. It is a required field and must be a string.

Endpoint: POST /api/

Request:

{
    "name": "Mark Essien"
}

Response:

{
    "id": 1,
    "name": "Mark Essien"
}

Endpoint: GET /api/{user_id}/

Response:

{
    "id": 1,
    "name": "Mark Essien"
}

Endpoint: PUT /api/{user_id}/

Request:

{
    "name": "Mark Essien Updated"
}

Response:

{
    "id": 1,
    "name": "Mark Essien Updated"
}

Endpoint: DELETE /api/{user_id}/

Response:

{
    "message": "Person with id 1 has been deleted"
}

# Creating a new person
import requests

url = "https://brianobot.pythonanywhere.com/api"
payload = {
    "name": "Mark Essien"
}
response = requests.post(url, json=payload)
print(response.json())

# Retrieving a person
user_id = 1
url = f"https://brianobot.pythonanywhere.com/api/{user_id}/"
response = requests.get(url)
print(response.json())

# Updating a person
user_id = 1
url = f"https://brianobot.pythonanywhere.com/api/{user_id}/"
payload = {
    "name": "Mark Essien Updated"
}
response = requests.put(url, json=payload)
print(response.json())

# Deleting a person
user_id = 1
url = f"https://brianobot.pythonanywhere.com/api/{user_id}/"
response = requests.delete(url)
print(response.json())

• 400 Bad Request: If the request is malformed or missing required fields.
• 404 Not Found: If the requested Person does not exist.
• 405 Method Not Allowed: If an unsupported HTTP method is used on an endpoint.

To Run the Automated Test, run the command (from within the project directory terminal)

python test.py

The Person Webservice provides a simple and easy-to-use interface for managing Person objects. It allows for creating, retrieving, updating, and deleting Person records through a RESTful API. Use the provided endpoints to interact with the service and manage your Person data.

• Brian Obot [email protected]