Skip to content

Latest commit

 

History

History
144 lines (109 loc) · 5.63 KB

README.md

File metadata and controls

144 lines (109 loc) · 5.63 KB
Raw

Mobility Feed API

Deploy Feeds API - QA Deploy Web App - QA Code style: black

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.

Authentication

To access the Mobility Feed API, users need to authenticate using an access token. Here is the step-by-step process to obtain and use an access token:

Registering for an Account

  1. Sign up at mobilitydatabase.org to create an account.
  2. Once registered, you can view your refresh token on the Account Details screen. This token is used to generate your access token.

Generating an Access Token

You can generate an access token either via the UI on the website or using a curl command:

  • Via UI: After logging in, navigate to the account page to generate or obtain your access token.
  • Via Command Line: 
    curl --location 'https://api.mobilitydatabase.org/v1/tokens' \
--header 'Content-Type: application/json' \
--data '{ "refresh_token": "[Your Refresh Token]" }'

Replace [Your Refresh Token] with the refresh token obtained after registration.

Using the Access Token

Once you have the access token, you can use it to make authenticated requests to the API. For Testing Access:

curl --location 'https://api.mobilitydatabase.org/v1/metadata' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer [Your Access Token]'

Replace [Your Access Token] with your actual access token.

Via Swagger UI

You can also use the Swagger UI to make requests. Input your access token in the required field in the Swagger interface.

Refreshing the Access Token

Access tokens are subject to expiration. Use your refresh token to generate a new access token when necessary.

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.10

Python 3.11 incompatibility notice

This project uses sqlacodegen to generate ORM models. This project is also depending on [SqlAlchemy]https://www.sqlalchemy.org/. This combination od dependencies doesn't support yet(August 2023) Python 3.11 due to bpo-45320.

Related issues:

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

Linter

This repository uses Flak8 and Black for code styling

To run linter checks:

scripts/lint-tests.sh

You can also use the pre-commit installed through requirements_dev.txt with

pre-commit install
pre-commit run --all-files

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)