Swagger interface for openfaas functions
- Document your Openfaas functions in OpenAPI 3.0 Spec and visualize it in a swagger ui.
- Uses the annotations in the function descriptor yml to look for the swagger config.
- Test functions from swagger ui
Navigate to the function folder to deploy the swagger yaml generator.
The function will generate the swagger yaml. To visualize, deploy the swaggerui-proxy component as below
ko apply -RBf config/
Once the component is created access the ui at /swaggerui/ path.
Add your api spec (json format) in the function descriptor(stack.yaml) as annotation. Use this example.
After deploying your function with this annotation, you should be able see the paths in swagger ui
- We are following open api 3.0 spec
- Please make sure the json is well formatted.
- In swagger 3.0, the spec is defined in yaml. You can define in yaml and convert to json using online editor like this
- If annotatation is not provided , by default just the path will be shown.
Supports the basic auth plugin.
Implement the OFAuth interface for other options
The swagger package can be used as a standalone in your GO function.
The team is open to contributions to our project. For more details, see our Contribution Guide.