OpenAPI ファイルのダウンロード - Docflow API

OpenAPI 仕様ファイル

API 連携開発やツールへのインポートで OpenAPI 仕様ファイルが必要な場合は、以下の URL から完全な OpenAPI 定義ファイルをダウンロードできます。 ダウンロード URL:

https://raw.githubusercontent.com/ichaozai/docflow-docs/refs/heads/master/docflow/ja/rest-api/openapi.bundle.yaml

利用方法

ダウンロードした OpenAPI ファイル（YAML 形式）には、DocFlow API の完全な API 定義が含まれています。以下の用途で利用できます。

API 開発ツールへのインポート: Postman、Insomnia、Apifox などにインポートし、API リクエストコレクションをすばやく生成できます。
クライアントコードの生成: OpenAPI Generator などのツールを使って、各種プログラミング言語向けの SDK コードを自動生成できます。
完全な API ドキュメントの確認: OpenAPI 仕様に対応したドキュメントツールで、詳細な API 説明を確認できます。

ファイル内容

このファイルには以下が含まれます。

すべての API エンドポイントの詳細定義
リクエストパラメータとレスポンス形式の説明
データモデルと構造定義
認証方式の説明
API のサンプルコード

ご不明点がある場合は、テクニカルサポートチームまでお問い合わせください。