Swagger, also known as OpenAPI, is a specification for describing the structure and behavior of a REST API. Swagger specifications are typically written with YAML and can be used to generate documentation, SDKs, and other useful artifacts.

One of FL0's nifty features is the ability to generate Swagger specifications for a project.

Creating Swagger specifications

By default, FL0 automatically generates Swagger specifications for a project's HTTP Request flows.

To see an example of a Swagger specification, follow these steps:

  1. Create an HTTP Request flow.
  2. In the sidebar, click Swagger.

FL0 lists the endpoints for sending requests to the project's flows, along with the request parameters and response objects of each endpoint.

You also have the option of sending example requests to the endpoints with a Try it out feature.

Disabling Swagger specifications

  1. Open a project.
  2. In the Explorer pane, click Configuration > System settings.
  3. Set the swaggerDisabled option to True.
  4. Click Save.