データのエクスポート

ApidogはOpenAPI仕様、HTML、Markdown、Apidogなどのデータ形式でのAPIのエクスポートに対応している。

データのエクスポート

左メニューバーの「設定」→「データのエクスポート」を選択し、希望するデータ形式を選んで「エクスポート」ボタンをクリックする。

すべてのAPIを一括でエクスポートすることも、特定のAPIを選択してエクスポートすることもできる。

タグでグループ化されたAPIを対象としたエクスポートも可能だ。

OpenAPI仕様 については、バージョン3.1、3.0、Swagger 2.0 に対応している。YAMLまたはJSON形式でエクスポートでき、Apidog拡張OpenAPIフィールドを含め、Tagsフィールドをフォルダとして使用したエクスポートが可能だ。

また、オフラインドキュメントとしてデータをエクスポートすることも可能だ。「URLを開く」をクリックすると、ブラウザで直接RAWコンテンツにアクセスして閲覧できる。

スプリントブランチからのエクスポート

ページ左上に表示されているブランチをエクスポート対象として選択することで、スプリントブランチからデータをエクスポートできる。スプリントブランチからエクスポートする場合、そのブランチのすべてのデータをエクスポートする必要がある。

エクスポートプロセスでは、データの完全性を確保するため、現在のスプリントブランチとメインブランチをマージする。この手順は重要で、Apidogの様々なデータ項目は参照を通じて相互に接続されているため、スプリントブランチの表示内容だけをエクスポートすると、不完全または使用できないデータになる可能性がある。

スプリントブランチからデータをエクスポートする場合、特定の一部分を選択することはできない。エクスポートには、スプリントブランチとメインブランチの間でマージされたすべてのコンテンツが自動的に含まれる。

OperationID

OperationIdは、OpenAPI仕様でAPI操作を一意に識別するために使用される識別子だ。OpenAPI形式でエクスポートする際、OperationId 属性を設定でき、この識別子がエクスポートされたOperation オブジェクトのOperationIdに含まれる。

OAS (OpenAPI Specification) のカスタムエクスポート設定

移動先: プロジェクト概要 > API仕様 > 設定/追加

表示されたインターフェースでカスタムエクスポートパラメータを設定する。

FAQ

Q: エクスポートされたAPIの数が減ってしまうのはなぜ？

A: 複数のAPIが同じメソッドとパスを使用している場合に発生することがある。HTMLとMarkdownはOpenAPIデータ変換を介してエクスポートされるが、この方式では複数のAPIが同じメソッドとパスを共有することをサポートしていない。

Q: MarkdownとHTMLにエクスポートした際、APIの順序が乱れるのはなぜ?

A: OpenAPIの一部であるSwagger仕様には、APIの順序付けやグループ化を明示的にサポートする機能がない。そのため、MarkdownとHTMLへのエクスポートでは整理されていない状態で表示されることがある。整理された状態でエクスポートしたい場合は、Apidogのネイティブ形式の使用を検討するといい。

Q: 複数のAPIが同じURLを持つ場合、エクスポートされるAPIの数が減るのはなぜ？

A: OpenAPI仕様では、複数のAPIが同じメソッドとパスを共有することを許可していない。各APIには固有のURLを使用するようにする必要がある。APIの一意識別子の確保について詳しくは、APIの一意識別を参照。HTMLとMarkdownのエクスポートは両方ともOpenAPIを介して行われるため、同じ制限が適用される。

Q: PDFにエクスポートするにはどうすればいい？

A: 現在、ApidogではPDFやWordへの直接エクスポートはサポートされていない。ただし、まずMarkdown形式でデータをエクスポートし、その後で外部ツールを使用して希望の形式に変換することができる。例えば、Typoraを使用すると、MarkdownをPDF、Word、OpenOffice、Epubなどの形式に変換できる。

Q: 複数のAPIのうち1つしかエクスポートされなかったのはなぜ？

複数のAPIが同じメソッドとパスを使用していないか確認する

OpenAPI仕様では、異なるAPIが同じメソッドとパスの設定を共有することを禁止している。詳しくはAPIの一意識別を参照

OpenAPIデータを介してHTMLやMarkdownに変換する際に問題が発生する可能性があることに注意

Q: 認証値をエクスポートするには？

A: Apidogは Auth 値をSwagger形式のファイル内に自動的にエクスポートする。追加の設定は必要ない。これらの値を確認するには、Swagger形式ファイルの securitySchemes セクションを確認する。

データのエクスポート