Getting started with the printing press

Industrial strength OpenAPI and AsyncAPI documentation in seconds.

Value in 60 seconds or your money back.

Install printing press

curl -fsSL https://pb33f.io/printing-press/install.sh | sh

If you do not use the shell installer, see the other installation options.

Download sample spec

Use the hosted Train Travel OpenAPI specification:

curl -o train-travel.yaml https://api.pb33f.io/bootstrap/train-travel

Print!

ppress ./train-travel.yaml

This prints the generated docs in ./api-docs.

Using AsyncAPI

Already have an AsyncAPI 3 contract? The command is exactly the same:

ppress ./events.asyncapi.yaml

printing press detects the contract type from the document. There is no protocol flag and no separate AsyncAPI mode.

AsyncAPI 3.x is supported. AsyncAPI 2.x is intentionally not supported. See the AsyncAPI guide for the rendered operation, channel, message and schema model.

Open the docs

open api-docs/index.html

It should open up in your browser, fully rendered and explorable.

The default output is static mode. Built for opening from disk, zipping, sending, or committing.

Preview published version locally

ppress --serve --output ./api-docs ./train-travel.yaml

Then open up http://127.0.0.1:9090 in a browser.

--serve renders in published mode and starts a local http server. Port 9090 is the default.

Try it live, now!

Just head over to the doctor and click the ‘API DOCS’ tab. You will see it running live and interactive.