An open API service indexing awesome lists of open source software.

https://github.com/entur/omsa-example-clients

Quick-start guide for connecting to Entur's OMSA API
https://github.com/entur/omsa-example-clients

bff dart entur fastapi flutter mobile omsa python

Last synced: 3 months ago
JSON representation

Quick-start guide for connecting to Entur's OMSA API

Awesome Lists containing this project

README

          

# OMSA Example Clients

![Status](https://img.shields.io/badge/status-WIP-purple)
![Last Commit](https://img.shields.io/github/last-commit/entur/omsa-example-clients)
![Issues](https://img.shields.io/github/issues/entur/omsa-example-clients)
![Pull Requests](https://img.shields.io/github/issues-pr/entur/omsa-example-clients)
![FastAPI](https://img.shields.io/badge/FastAPI-009688?logo=fastapi&logoColor=white)
![Flutter](https://img.shields.io/badge/Flutter-02569B?logo=flutter&logoColor=white)

This repository hosts a complete demo of how clients may integrate with Entur's implementation of the [Open Mobility Sales API (OMSA)](https://github.com/OMSA-Open-Mobility-Sales-API/OMSA). Each client lives under `clients/`, each backend-for-frontend (BFF) under `bffs/`. Shared documentation and guides for BFF + client combinations live under `docs/`.

## Repository layout
```
clients/
flutter/ Cross-platform mobile client
bffs/
python-fastapi/ Reference FastAPI BFF
docs/ Shared documentation and BFF + client integration guides
```

## Getting started
- Each project documents its own setup:
- [clients/flutter/README.md](clients/flutter/README.md) covers the Flutter demo app.
- [bffs/python-fastapi/README.md](bffs/python-fastapi/README.md) covers the FastAPI BFF.
- Integration guides live in `docs/`. Start with [docs/flutter-fastapi-guide.md](docs/flutter-fastapi-guide.md) to run the Flutter client against the FastAPI BFF.

## Documentation
- Add new client/BFF pairings under `docs/` as `client-bff-guide.md` to keep combinations discoverable (e.g. `react-express-guide.md`).
- Official OMSA specification:

## Having problems?
Please [open an issue](https://github.com/entur/omsa-example-clients/issues/new/choose) if you encounter bugs or have feature requests.