zato apispec


Generates API documentation for services that use SimpleIO. The documentation is output as a Sphinx project containing an OpenAPI specification and an HTML dashboard. Before executing this command, make sure that Sphinx is installed in the system.

The server that this command uses must be up and running, it cannot be stopped.

After running zato apispec, navigate to the output directory and run the command below to build HTML pages with the documentation ..

   $ cd <output-dir>
   $ make html

.. where <output-dir> is the directory that was created or overwritten by zato apispec.

Usage example

$ zato apispec /path/to/server --include="my.api.*, my.api.v2" --dir my-apispec
Output saved to /home/zato/my-apispec

$ cd /home/zato/my-apispec
$ make html

After running the command above, documentation will be available in /home/zato/my-apispec/_build/html/index.html.

Read more

Consult zato openapi which is a similar command that only outputs OpenAPI definitions, without HTML.