zato apispec

Vue d'ensemble

Génère une documentation API pour les services qui utilisent SimpleIO. La documentation est sortie sous la forme d'un projet Sphinx contenant une spécification et un dashboard HTML. Avant d'exécuter cette commande, assurez-vous que Sphinx est installé sur le système.

Le serveur utilisé par cette commande doit être opérationnel, il ne peut pas être arrêté.

Après avoir exécuté zato apispec, naviguez dans le répertoire de sortie et exécutez la commande ci-dessous pour construire des pages HTML avec la documentation ..

   $ cd <output-dir>
   $ make html

.. où <output-dir> est le répertoire qui a été créé ou écrasé par zato apispec.

Exemple d'utilisation

$ 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

Après avoir exécuté la commande ci-dessus, la documentation sera disponible dans /home/zato/my-apispec/_build/html/index.html.

Lire la suite

Consultez zato openapi qui est une commande similaire qui ne sort que les définitions OpenAPI, sans HTML.