faas-rs/faas
1
0
Fork 0
mirror of https://github.com/openfaas/faas.git synced 2025-06-08 16:26:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Create README.md

Browse Source
This commit is contained in:
Alex Ellis 2017-08-25 10:15:00 +01:00 committed by GitHub
parent 80f42c8e83
commit 9639bc732b
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
api-docs/README.md Normal file
View File

@ -0,0 +1,11 @@
## 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.