Skip to content

Gateway

OpenFaaS API Gateway / Portal

Pictured: OpenFaaS conceptual design with Kubernetes

Reference documentation

You can find the reference documentation and any additional settings for the API gateway in the README file for the gateway:

Swagger

The OpenFaaS API exposes a RESTful API which is documented with Swagger.

Explore or update the Swagger API documentation

The swagger.yml file can be viewed and edited in the Swagger UI.

  • Head over to the Swagger editor

  • Now click File -> Import URL

  • Type in https://raw.githubusercontent.com/openfaas/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.