OpenAPI / Swagger Integration

FLAT uses the well-known OpenAPI 2.0 definition aka "Swagger" to describe its API. Many developers know this format and have worked with it before, primarily to document their APIs.

This section covers all FLAT features that integrate with Swagger.

By default, FLAT tries to read its API definition from the swagger.yaml file in the project's top-level directory. You can configure a different path (or even choose one dynamically) in conf/config.xml.

FLAT uses Swagger Extensions prefixed with the x-flat- namespace to augment the swagger.yaml.

Routing

Validation

Security Check

Mocking

CORS

Upstream APIs

Differences from Swagger