API Platform natively generates rich, interactive documentation. However, for automation needs (CI/CD), client generation, or importing into tools like Postman, it is essential to know how to export this specification statically.

The Essential Command: api:swagger:export

In recent versions of API Platform, the command has evolved to focus on the OpenAPI standard. It allows you to instantly dump all your resources, data types, and endpoints.

Syntax and Standard Usage

To export your documentation in JSON format to your project root:

bin/console api:swagger:export --output=openapi.json

Advanced Customization Options

• --yaml: The default export is JSON. Use this option to get a YAML file, which is often more human-readable.
  bin/console api:swagger:export --yaml --output=openapi.yaml
• --spec-version: Allows forcing a specific version (2.0, 3.0.0, 3.1.0). Very useful for compatibility with older SDK code generators.
• --format: Allows specifying the normalization format if you have specific serialization needs.

Why Automate This Export?

Static exportation offers major advantages for team productivity:

• Contract Testing: Validate that changes in your Symfony code do not break the interface contract expected by the Front-end.
• Client Generation: Use tools like OpenAPI Generator to automatically create TypeScript, Swift, or Go SDKs from the exported file.
• Documentation Portal: Power external portals like Redoc or Stoplight to offer public documentation outside your production app.

By integrating bin/console api:swagger:export into your deployment scripts, you ensure that your reference documentation is always synchronized with your production code.