Mobility Feed API

The Mobility Feed API service a list of open mobility data sources from across the world. This repository is the effort the initial effort to convert the current The Mobility Database Catalogs in an API service.

Work in Progress Status

Mobility Feed API is not released yet; any code or service hosted is considered as Work in Progress. For more information regarding the current Mobility Database Catalog, go to The Mobility Database Catalogs.

Viewing the API with Swagger.

Follow this link.

Local development

Folder api contains source code of the API implementation. This repository relies on openapi-generator for spec-first development with fastapi as the server stub generator. Generated files are placed in src\feeds_gen; this folder is ignored in git as it should not be modified. API's endpoint classes and methods are located in src\feeds\impl.

Requirements.

Python == 3.11

Installation & Usage

As a one time step, download the openapi-generator-cli.sh script using:

scripts/setup-openapi-generator.sh

Install dependencies

cd api
pip3 install -r requirements.txt
pip3 install -r requirements_dev.txt

Generates an instance of the database locally using docker-compose

docker-compose --env-file ./config/.env.local  up -d --force-recreate

Generates the api and database stubs on first run and everytime the schema changes

scripts/api-gen.sh
scripts/db-gen.sh

In case you modify the database schema, you can run docker-compose --env-file ./config/.env.local up schemaspy -d --force-recreate which will update your local instance of the database and the related schema documentation located in docs/schemapy-dev/index.html.

Run local API

scripts/api-start.sh

Unit tests

Test are located in tests directory.

To run all tests:

scripts/api-start.sh

Local swagger documentation

To have access to the API's produced swagger documentation:

scripts/api-start.sh

and open your browser at http://localhost:8080/docs/ to see the docs.

IDE Python modules

If your Python's IDE is not able to resolve the python module; make sure the api/src folder is marked as source directory.

Tests

To run the all tests:

scripts/api-tests.sh

To run a single test file:

scripts/api-tests.sh <my_test_filename>.py

Running with Docker

Before starting the docker container make sure the OpenApi generated files are present by running:

scripts/api-gen.sh

To run the server on a Docker container, please execute the following from the root directory:

(cd api && docker-compose up --build)

davidgamez/mobility-feed-api