Comment générer des documents d'API Swagger hors ligne?

J'ai un ressort de démarrage MVC en java Web app. J'ai été en mesure d'intégrer Springfox pour la documentation de l'API. Je peux voir toutes les Api lorsque le serveur est en place et en cours d'exécution.

Comment puis-je générer en mode HORS connexion swagger documentation de l'API? Note: je ne souhaite pas utiliser asciidoc ou de démarque de la documentation, mais je voudrais la même arrogance de l'API de l'interface utilisateur dans les fichiers html. J'aimerais donc que les liens sont relatifs au répertoire local au lieu du serveur hôte local liens de. Grâce

source d'informationauteur codeshark

  1. 5

    Springfox vous permet de créer facilement un Swagger testeur/docs de l'API en fonction de votre Ressort des annotations.

    Swagger a lui-même certains des outils pour vous permettre de générer en ligne/hors de la documentation statique:

    • La Swagger Éditeur a plusieurs façons de générer des documents mentionnés dans la Générer Client menu
    • La Swagger Codegen module vous permet de générer un statique et dynamique document HTML

    Deux d'entre eux nécessitent un Swagger YAML ou fichier JSON. Dans le cas où vous n'avez pas de Swagger définition en YAML/JSON parce que vous êtes à l'aide de Springfox, vous pouvez utiliser le fichier généré utilisé pour le Style de l'INTERFACE utilisateur (/v2/api-docs?group=<group name>).

  2. 4

    Swagger a outil pour la génération de documents hors connexion.

    L'outil est "Swagger2Markup" qui est situé @ Github.

    La sortie de "Swagger2Markup" peut être utilisé comme une alternative à swagger-interface utilisateur et peut être servi comme un contenu statique.

    Voici un Exemple

    Bonne chance! 🙂

  3. 2

    Vous pouvez essayer "HTML" ou "HTML Dynamique" en vertu de "Générer le Client" menu dans https://editor.swagger.io. Pour toute question/commentaire avec le statique de la doc, merci de l'indiquer dans le Swagger Codegen dépôt Github.

    de l'éditeur.swagger.io exploite https://generator.swagger.io pour générer du code et de la génératrice.swagger.io (Swagger Générateur) est une partie de l'Arrogance Codegen projet.

  4. 1

    Vous pouvez prendre un coup d'oeil à https://www.DynamicApis.com. Vous pouvez créer une API de portail et de télécharger votre swagger documents JSON. Ce site prend de l'Aisance document et génère beaucoup plus de l'interface utilisateur de votre API, ainsi que certains assez cool de l'outillage.

    Ici est un exemple d'un portail de l'API qui a de la documentation sur l'un de leurs Api.

  5. 1

    Jolie-swag est une INTERFACE utilisateur pour Swagger Spécification V2 capable de générer des fichiers HTML statiques un d'autres formats. Il est inspiré par le Style de l'Éditeur.

    caisse https://github.com/twskj/pretty-swag