Zepto API Documentation

Welcome to the Zepto API documentation source.

Zepto's API Documentation is hosted at docs.zeptopayments.com and powered by readme.

Note that some parts of the docs published at docs.zeptopayments.com are maintained outside of this repo.

API Reference

How does it work?

• The Zepto 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.

Starting application locally

make start # Ctrl+C to stop

Making changes

1. With the application running, edit the source/openapi3/split.yaml or any themes/templates. The preview should update a few seconds after you save your changes.
2. Changes to the YAML file will be built and output to source/index.html.md, courtesy of Guard (see the Guardfile). (Don't edit the output file directly).
3. Commit both the YAML and the build output changes.

Note: Currently only changes to split.yaml will trigger the automatic update.

Developer Guides

Making changes

1. Make changes to the Developer Guides directly in the source/guides markdown files (there is no need for the application to be running). For example:

• source/guides/zepto-api.md
• source/guides/webhooks.md

2. Commit your changes.

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.

make publish

Notes

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

Thanks

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