zato openapi

Overview

Generates API documentation for services in the form of an OpenAPI definition that can be imported by any tool or framework that is compatible with OpenAPI 3.x.

All services that the command exports API documentation for are assumed to use SimpleIO.

Usage example

$ zato openapi /path/to/server --include="my.api.*, my.api.v2" --delete-file
Output saved to /tmp/openapi.yaml
$

Read more

Consult zato apispec which is a similar command that outputs a HTML dashboard in addition to an OpenAPI definition.