Pique API is a FastAPI-based web service for accessing and managing Mountain Peaks. It uses a PostGIS-enabled PostgreSQL database for storage and querying.
Pique API is a small example project and has no real-world use case. As such, minimal or no support will be provided.
- Docker
- Python (for testing only)
Clone this repository:
git clone https://github.com/vgalin/pique-api.gitCD into the cloned directory and run a docker-compose build:
cd pique-api
docker-compose buildStart the Docker containers:
docker-compose upThe API will then be available at http://localhost:80.
GET /: Welcome messageGET /peaks/{peak_id}: Retrieve peak with specified ID.GET /peaks/: Search for peaks within a specified box or range.POST /peaks/: Create a new peak.PUT /peaks/: Update a peak.DELETE /peaks/: Delete a peak.
When the API is running, its full documentation is available at http://localhost/docs or http://localhost/redoc.
As GET /peaks/ is the only non trivial endpoint, here is a quick explanation of its parameters.
The /peaks/ endpoint supports the following query parameters for searching peaks within a box:
lon_min: The minimum longitude of the box.lat_min: The minimum latitude of the box.lon_max: The maximum longitude of the box.lat_max: The maximum latitude of the box.
Alternatively, the following query parameters can be used to search for peaks within a specified range:
range_in_meters: The range to search within, in meters.lat: The latitude of the center of the range.lon: The longitude of the center of the range.
Tests are run from the local machine.
Install the Python packages required for testing:
python -m pip install -r requirements-tests.txtRun the tests (while being at the root directory of this repository):
python -m pytest- Different configuration for dev/prod
- Better way to query using
GET /peaks/ - Homogenize in/out format? (lat/long integers in input VS WKT in output)
- Github actions
- Extend existing tests
This project is licensed under the MIT License.