https://github.com/maasglobal/maas-tsp-api

WhimApp TSP (Transport Service Provider) Open API
https://github.com/maasglobal/maas-tsp-api

api api-definition api-documentation mobility-as-a-service openapi openapi-specification swagger transportation

Last synced: 2 months ago
JSON representation

WhimApp TSP (Transport Service Provider) Open API

• Host: GitHub
• URL: https://github.com/maasglobal/maas-tsp-api
• Owner: maasglobal
• License: mit
• Created: 2016-05-10T03:35:39.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-04-04T06:40:25.000Z (almost 5 years ago)
• Last Synced: 2024-07-14T16:58:28.377Z (7 months ago)
• Topics: api, api-definition, api-documentation, mobility-as-a-service, openapi, openapi-specification, swagger, transportation
• Language: JavaScript
• Homepage: https://maasglobal.github.io/
• Size: 17.3 MB
• Stars: 15
• Watchers: 27
• Forks: 17
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# WhimApp TSP (Transport Service Provider) API

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](https://whimapp.com)

An interactive version of this documentation is published at [maasglobal.github.io](https://maasglobal.github.io/maas-tsp-api).

For a brief walk through of a booking process [see here](specs/Booking.md)

## Getting started

- spec/booking.yml - OpenAPI Specification for TSP provider booking

## Living documentation

To run it locally, execute

```

npm install

npm start

```

Open browser and navigate to documentation portal (http://localhost:3000)

- Redoc UI for documentation

- Examples

## Build the static website with documentation

```

npm run build

npm run dist

```

## Related projects

Data model are provided by [maas-schemas](https://github.com/maasglobal/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](specs/booking.yml)

## Links

- https://github.com/maasglobal/maas-schemas/

- https://swagger.io/specification/

- https://github.com/Redocly/redoc/