compose

Overview ¶

Command compose is the command line tool of the compose module.

Install it with

go install github.com/vanclief/compose/cmd/compose@latest

The reference subcommand renders the API reference page of an OpenAPI spec, optionally showing what changed since a base spec, to a file, to stdout, or from a local HTTP server that re-renders on every request:

compose reference -head openapi.yaml -base previous.yaml -out page.html
compose reference -head openapi.yaml -base previous.yaml -serve 127.0.0.1:8090

Exit codes are 0 on success, 1 on a runtime error and 2 on a usage error.