faas/api-docs/README.md
2017-08-25 10:15:00 +01:00

12 lines
408 B
Markdown

## Exploring or editing the Swagger API documentation
The `swagger.yml` file can be viewed and edited in the Swagger UI.
* Head over to the [Swagger editor](http://editor.swagger.io/)
* Now click File -> Import URL
* Type in `https://raw.githubusercontent.com/alexellis/faas/master/api-docs/swagger.yml` and click OK
You can now view and edit the Swagger, copy back to your fork before pushing changes.