Comment générer des documents API Swagger hors ligne?
J'ai un Spring Boot MVC Java Application Web. J'ai pu intégrer Springfox pour la documentation de l'API. Je peux voir visuellement toutes les API lorsque le serveur est opérationnel.
Comment puis-je générer la documentation de l'API swagger OFFLINE? Remarque: je ne voudrais pas utiliser la documentation d'asciidoc ou de démarque, mais j'aimerais la même interface utilisateur de l'API swagger dans les fichiers html. Je voudrais que les liens soient relatifs au répertoire local au lieu des liens du serveur hôte local. Merci
Springfox vous permet de créer facilement un testeur Swagger/des documents API basés sur vos annotations Spring.
Swagger lui-même dispose de quelques outils pour vous permettre de générer une documentation hors ligne/statique:
- Swagger Editor a plusieurs façons de générer la documentation répertoriée dans le menu Generate Client
- Le module Swagger Codegen vous permet de générer un document HTML statique et dynamique
Les deux nécessitent un fichier Swagger YAML ou JSON. Si vous n'avez pas de définition Swagger dans YAML/JSON parce que vous utilisez Springfox, vous pouvez utiliser le fichier généré utilisé pour Swagger UI (/v2/api-docs?group=<group name>).
Swagger dispose d'un outil pour générer des documents hors ligne.
L'outil est " Swagger2Markup " qui se trouve @ Github.
La sortie de "Swagger2Markup" peut être utilisée comme alternative à swagger-ui et peut être utilisée comme contenu statique.
Bonne chance! :)
Vous pouvez essayer "HTML" ou "HTML dynamique" dans le menu "Générer le client" dans https://editor.swagger.io . Pour tout problème/commentaire avec le document statique, veuillez le signaler dans le repo Swagger Codegen Github.
editor.swagger.io utilise https://generator.swagger.io pour générer du code et generator.swagger.io (Swagger Generator) fait partie du projet Swagger Codegen.
Ouvrez le HTML swagger en direct. cliquez sur développer toutes les opérations. Enregistrez ensuite le HTML au format PDF.
Cela devrait vous donner une documentation décente PDF API avec tous les détails.
Pretty-Swag est une interface utilisateur pour Swagger Specification V2 capable de générer du HTML statique et d'autres formats. Il est inspiré de Swagger Editor.
Vous pouvez jeter un œil à https://www.DynamicApis.com . Vous pouvez créer un portail API et télécharger vos documents JSON swagger. Ce site prend le document Swagger et génère une interface utilisateur beaucoup plus agréable pour votre API ainsi que des outils assez sympas.
Ici est un exemple d'une API de portail qui a de la documentation sur l'une de leurs API.