This is the WhimApp TSP (Transport service provider) API repository, containing OpenAPI specification, JSON schema for data model and examples.
Using these documents, a third party transport service provider can implement a MaaS compatible API ready to be integrated into WhimApp
An interactive version of this documentation is published at maasglobal.github.io.
For a brief walk through of a booking process see here
- spec/booking.yml - OpenAPI Specification for TSP provider booking
To run it locally, execute
npm install
npm start
Open browser and navigate to documentation portal (http://localhost:3000)
- Redoc UI for documentation
- Examples
npm run build
npm run dist
Data model are provided by maas-schemas which are used in API specification to declare and validate request and response payloads.
To create local, OpenAPI specification compatible copy of this schemas, execute npm run build. This will create local schemas folder which are referenced in specs/booking.yml