Wie generieren Sie offline Swagger API-Dokumente?

Question

Ich habe eine Spring Boot MVC Java Web App. Ich konnte Springfox für die API-Dokumentation integrieren. Ich kann alle APIs visuell sehen, wenn der Server läuft und läuft.

Wie kann ich OFFLINE Swagger API Dokumentation erzeugen? Hinweis: Ich möchte nicht Asciidoc oder Markdown-Dokumentation verwenden, aber ich möchte die gleiche Swagger-API-Benutzeroberfläche in HTML-Dateien. Ich möchte, dass die Links relativ zu lokalen Verzeichnis statt lokalen Host-Server-Links sind. Danke

Answer 1

Sie können "HTML" oder "Dynamic HTML" unter dem "Generate Client" Menü in https://editor.swagger.io versuchen. Für jedes Problem/Feedback mit dem statischen Dokument, melden Sie sich bitte im Swagger Codegen Github Repo.

editor.swagger.io nutzt https://generator.swagger.io, um Code zu generieren, und generator.swagger.io (Swagger Generator) ist Teil des Swagger Codegen-Projekts.

Answer 2

Mit Springfox können Sie auf einfache Weise Swagger-Tester/API-Dokumente basierend auf Ihren Spring-Anmerkungen erstellen.

Swagger sich einige Werkzeuge hat, damit Sie offline/statische Dokumentation generieren:

• Die Swagger Editor hat mehrere Möglichkeiten der Dokumentation im generieren Client- Menü können Sie
• Das Swagger Codegen Modul aufgelistet Erzeugen erzeugt ein statisches und dynamisches HTML-Dokument

Beide benötigen eine Swagger YAML- oder JSON-Datei. Falls Sie in YAML/JSON keine Swagger-Definition haben, weil Sie Springfox verwenden, können Sie die generierte Datei verwenden, die für Swagger UI verwendet wird (/v2/api-docs?group=<group name>).

Answer 3

Sie können einen Blick auf https://www.DynamicApis.com werfen. Sie können ein API-Portal erstellen und Ihre Swagger-JSON-Dokumente hochladen. Diese Website nimmt das Swagger-Dokument und generiert eine viel schönere Benutzeroberfläche für Ihre API zusammen mit einigen ziemlich coolen Werkzeugen.

Here ist ein Beispiel für eine Portal-API, die Dokumentation zu einer ihrer APIs enthält.

Answer 4

Swagger hat ein Tool zum Generieren von Offline-Dokumenten.

Das Werkzeug ist "Swagger2Markup", die @ Github befindet.

Die Ausgabe von "Swagger2Markup" kann als Alternative zu swagger-ui verwendet werden und kann als statischer Inhalt verwendet werden.

Here is an Example

Viel Glück! :)

Answer 5

Pretty-Swag ist eine Benutzeroberfläche für Swagger Specification V2 in der Lage, statische HTML-Formate und andere Formate zu generieren. Es wurde von Swagger Editor inspiriert.

zur Kasse gehen https://github.com/twskj/pretty-swag