Basic REST API for tracking objects

Python version 3.8.5

To install all required packages: pip3 install -r requirements.txt

To run server: py main.py

To view frontend: Go to http://localhost:5000/

List all spaceships

GET

http://localhost:5000/spaceship

Returns all spaceships that exist (ordered by ID) in JSON form

Add spaceship

POST

http://localhost:5000/spaceship

Creates a spaceship with the given information

Example payload:

{
    "name": "Shippy",
    "model": "Fast",
    "location": 1,
    "state": "Maintenance"
}

Update a spaceship's state

PUT

http://localhost:5000/spaceship

Update a spaceship's state to another state.

Possible states:

• Decommissioned
• Maintenance
• Operational

spaceshipID must match an existing spaceship

state must match one of the possible states

Example payload:

{
    "spaceshipID": 1,
    "state": "Operational"
}

Add location

POST

http://localhost:5000/location

Creates a location with the given information

Example payload:

{
    "city": "Sydney",
    "name": "Gas station",
    "planetName": "Earth",
    "capacity": 50
}

Remove a spaceship

DEL

http://localhost:5000/spaceship

Removes a spaceship with a matching ID

Example payload:

{
    "spaceshipID": 1
}

Remove a location

DEL

http://localhost:5000/location

Removes a location with a matching ID

Example payload:

{
    "locationID": 1
}

Travel

POST

http://localhost:5000/travel

Example payload:

{
    "spaceshipID": 0,
    "locationID": 1,
}

• id (Primary key, INT)
• name (VARCHAR)
• model (VARCHAR)
• location (Foreign key, INT) -> FK to id field in Location table
• status (VARCHAR)

• id (Primary key, INT)
• city (VARCHAR)
• name (VARCHAR)
• planetName (VARCHAR)
• currentCapacity (INT)
• maxCapacity (INT)