OzBob / api-documentation

Split Payments API Documentation

Split API Documentation

Welcome to the Split API documentation source.

How does it work?

• The Split API is documented using the OpenAPI 3.0.0 specification.
• The new Swagger editor was used to get the boilerplate done.
• The API spec is then converted to Slate friendly markdown with Widdershins.

Get started

1. Clone the repo
2. $ bundle install
3. $ yarn install
4. Edit the source/openapi3/split.yaml or any themes/templates
5. $ yarn run widdershins -e options.yml ./source/openapi3/split.yaml -o ./source/index.html.md
   1. Preview: $ bundle exec middleman server

Publishing changes

Warning: this script will push changes directly to Github pages. They will be publicly visible. You should only run this after your changes have been reviewed and merged.

$ ./deploy.sh

Notes

• The Slate template/theme is mildly edited to suite our style.
• The same goes for Widdershin's conversion templates.

Thanks

Thanks to the teams at Widdershins, Slate, Swagger and OpenAPI spec.