Documentation hosted here: https://kchonka.github.io/citybikes-api-docs/
This API documentation explains how to use the CityBikes API for developers.
CityBikes, powered by PyBikes, is an open-source project providing information about global bike-sharing transportation services.
This documentation leverages Redoc to enhance the existing documentation by elaborating on all endpoints, requests and responses, schemas, error codes, authentication requirements, and examples.
This project is intended for educational purposes.
These are to be run from the root directory.
- To merge all your standalone files into a single definition file called bundled.yaml in the openapi directory:
redocly bundle openapi/openapi.yaml --output openapi/bundled.yaml
- To preview the documentation locally:
redocly preview-docs openapi/bundled.yaml --config redocly.yaml
This also uses the redocly.yaml config file for styling/theme settings.
- To create a dist.json file in the docs directory for documentation that can be deployed online:
redocly bundle openapi/openapi.yaml -o docs/dist.json
For configuring Redoc in HTML, see: https://redocly.com/docs/redoc/deployment/html/