web-dev-qa-db-ja.com

PDFおよびXMLファイルでSwaggerドキュメントをエクスポートする方法

以下のリンクを使用して、Web API用のSwaggerドキュメントを生成しました： http://wmpratt.com/swagger-and-asp-net-web-api-part-1/

ドキュメントをPDFまたはXMLファイルでエクスポートして、便利に送信する必要があります。

その.NETWEBAPI。

Swaggerドキュメントをエクスポートする方法は？

ありがとう

pdfasp.net-web-apiswaggerswagger-uichm
8
user3711357

Swagger2Markup および AsciiDoc dockerイメージを使用できます。

docker run --rm -v $(pwd):/opt swagger2markup/swagger2markup convert -i "https://api.example.org/api/doc/swagger.json" -f /opt/swagger-doc

現在のフォルダに「swagger-doc.adoc」という名前のasciidocファイルを作成します。

docker run -it -v $(pwd):/documents/ asciidoctor/docker-asciidoctor asciidoctor-pdf swagger-doc.adoc

現在のフォルダに「swagger-doc.pdf」という名前のPDFファイルを作成します。

9
Gabriel Arellano

Swagger2MarkupプロジェクトはGitHubにあり、Googleを使用してさらに情報を見つけることができます。

Swagger2Markupは、Swagger JSONまたはYAMLファイルをいくつかのAsciiDocまたはGitHubフレーバーマークダウンドキュメントに変換し、手書きのドキュメントと組み合わせることができます。

AsciiDoc は、より多くの機能を備えているため、Markdownよりも適しています。 AsciiDocは、ドキュメント、記事、書籍、電子書籍、スライドショー、Webページ、ブログを作成するためのテキストドキュメント形式です。 AsciiDocファイルはHTML、PDF、EPUBに変換できます。AsciiDocはJavaDocやアノテーションよりもパブリックAPIの記述にはるかに適しています。

HTML5、PDFおよびEPUBドキュメントは、asciidoctorjを介して、またはasciidoctor-gradle-pluginまたはasciidoctor-maven-pluginを介して生成できます。

プロジェクトには少なくともJDK8が必要です。

参照 SwaggerとAsciiDocを使用したRESTful APIドキュメント

2
help-info.de

これらの他のプロジェクトの多くは、面倒な回避策、追加のライブラリ、または完全に別個の言語を必要とするため、今日私が行ったことは次のとおりです。

  • https://editor.swagger.io/ に移動します（HTTPSバージョンであることを確認してください）
  • 上部で、File => Import Fileをクリックします。
  • SwaggerJSONファイルを選択します。
  • 上部にあるGenerate Client => HTML2をクリックして、Zipファイルをダウンロードします。

これにより、静的なHTMLページが生成され、組み込みのMicrosoft Print to PDFプリンター、またはAdobe Acrobatを使用して）PDF）に印刷できます。 、または他に使用したいものは何でも。

0
killa-byte

それらは、swaggerドキュメントをPDFまたは他のドキュメントにエクスポートするようなツールや機能ではありません。swagger.jsonファイルをyamlファイルに変換する必要があります。そうすれば、swaggerをhtmlドキュメント形式として取得できます- http://editor.swagger.io/ 。

0
user10775215