Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. APIドキュメント公開
  • Apidog学習センター
  • はじめに
    • Apidog紹介
    • Apidog基本操作
      • 概要
      • 新しい APIを作成
      • APIにリクエストを送信
      • アサーションを追加
      • テストシナリオを作成
      • APIドキュメントを共有
      • さらなる探究
      • リクエストを送信してAPIとして保存
    • Apidog基本知識
      • Apidog操作方法
      • Apidogの基本概念
    • 移行
      • 概要
      • 手動インポート
      • 定期インポート
      • インポートオプション
      • データのエクスポート
      • Import from...
        • Postman からインポート
        • OpenAPI(Swagger)仕様のインポート
        • cURLのインポート
        • Markdownのインポート
        • Insomniaからのインポート
        • apiDocからのインポート
        • .harファイルのインポート
        • WSDLのインポート
  • API設計
    • 概要
    • コンポーネント
    • 常用フィールド
    • グローバルパラメータ
    • API変更履歴
    • プロジェクトの作成
    • 一括API管理
    • APIの基本
    • 複数のリクエストボディ例の設定
    • Schemas
      • 概要
      • 新規Schemaの作成
      • スキーマを構築する
      • JSONなどからのSchema生成
    • Security schemes
      • 概要
      • Security Schemeの作成
      • Security Schemeの使用
      • オンラインドキュメントにおけるSecurity Scheme
    • 高度な機能
      • APIをテストステップとしてインポート
      • パラメータリストの表示形式
      • APIのカスタムフィールド
      • APIのステータス
      • API固有識別子
  • API開発とデバッグ
    • 概要
    • リクエストの生成
    • リクエストの送信
    • コード生成機能
    • APIケース
    • 動的な値
    • レスポンスの検証
    • 設計優先 & リクエスト優先
    • 環境 & 変数
      • 概要
      • 環境とサービス
      • 変数の使い方
    • Vault secrets
      • 概要
      • AWS Secrets Manager
      • Azure Key Vault
      • HashiCorp Vault
    • 前/後処理
      • 概要
      • Wait
      • 変数の抽出
      • アサーション
      • データベース操作
        • 概要
        • MongoDB
        • Redis
        • Oracle クライアント
      • スクリプト利用
        • 概要
        • 前処理スクリプト
        • 後処理スクリプト
        • Postmanスクリプトリファレンス
        • 共通スクリプト
        • 他のプログラミング言語の呼び出し
        • JSライブラリの使用
        • レスポンスの可視化
        • スクリプトの例
          • その他の例
          • スクリプトを使用したリクエストメッセージの変更
          • スクリプトでの変数の使用
          • アサーションスクリプト
    • 動的値モジュール
  • APIモック
    • 概要
    • スマートMock
    • カスタムMock
    • Mockの優先順位
    • Mockスクリプト
    • クラウドMock
    • セルフホストランナーMock
    • Mock言語 (ロケール)
  • 自動テスト
    • 概要
    • テストレポート
    • テストシナリオ
      • テストシナリオの作成
      • 他のプロジェクトからAPI/APIケースをインポートする
      • リクエスト間でデータを渡す
      • API/APIケースからのデータ同期
      • フロー制御条件
      • テストシナリオのエクスポート
    • テストシナリオ実行
      • データ駆動型テスト
      • スケジュールタスク
      • テストシナリオを一括実行する
      • 他のプロジェクトのAPIの実行環境を管理する
      • テストシナリオを実行する
    • APIテスト
      • 統合テスト
      • 回帰テスト
      • エンドツーエンド(E2E)テスト
      • パフォーマンステスト
    • Apidog CLI
      • 概要
      • Apidog CLIのインストールと実行
      • Apidog CLI オプション
    • CI/CD
      • 概要
      • Jenkinsとの連携
      • Gitlabとの統合
  • APIドキュメント公開
    • 概要
    • Google AnalyticsとDoc Sitesの連携
    • CORS プロキシ
    • クイック共有
    • 可視性設定
    • ドキュメントURLに値を埋め込む
    • APIドキュメントを表示する
    • フォルダツリー設定
    • API SEO設定
    • カスタムレイアウト
    • ドキュメント検索
    • カスタムドメイン
    • ドキュメントサイトの公開
    • APIバージョン
      • 概要
      • APIバージョンの作成
      • APIバージョンの公開
      • APIバージョンごとにAPIの共有
  • リクエスト送信
    • 概要
    • GraphQL
    • gRPC
    • WebSocket
    • SSEデバッグ
    • SOAP/Webサービス
    • デバッグ用のリクエストプロキシエージェントを使用する
    • Socket.IO
    • リクエスト作成
      • リクエストの基本
      • パラメータとボディ
      • リクエストヘッダー
      • リクエスト設定
      • HTTP/2
      • リクエスト履歴
    • 認証と認可
      • 概要
      • CAとクライアント証明書
      • Apidogがサポートする認可タイプ
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • レスポンスとクッキー
      • 概要
      • ApidogのAPIレスポンス
      • Cookieの作成と送信
      • リクエストのデバッグ
      • リクエストをAPIとして保存
  • ブランチ管理
    • 概要
    • 新しいスプリントブランチの作成
    • スプリントブランチの管理
    • ブランチ内でのAPIテスト
    • ブランチでAPIの設計
    • スプリントブランチのマージ
  • Apidog MCP Server
    • 概要
    • Apidogプロジェクト内のAPI仕様をApidog MCPサーバー経由でAIに接続する
    • Apidogが公開したオンラインAPIドキュメントをApidog MCPサーバー経由でAIに接続する
    • Apidog MCPサーバーを介してOpenAPIファイルをAIに接続する
  • ベストプラクティス
    • ガイド:ChatGPT APIのトークンとコスト計算
    • Apidog コラボレーションワークフロー
    • API署名の取り扱い方法
    • Apidogでの認証状態の管理
    • OAuth 2.0で保護されたAPIにアクセスする方法
  • 管理
    • オンボーディングチェックリスト
      • 基本概念
      • Apidogスタートアップガイド
    • チーム管理
      • チーム管理
      • チームメンバーの管理
      • メンバーの役割と権限設定
      • チーム活動
      • チームリソース
        • 一般ランナー
        • チーム変数
        • リクエストプロキシエージェント
        • データベース接続
      • リアルタイムコラボレーション
        • チームコラボレーション
    • プロジェクト管理
      • プロジェクト管理
      • プロジェクトメンバーの管理
      • 通知設定
    • 組織管理
      • シングルサインオン(SSO)
        • 概要
        • Microsoft Entra IDの設定
        • Okta設定
        • 組織のSSOを設定する
        • チームへのグループのマッピング
        • ユーザーアカウントの管理
      • SCIMプロビジョニング
        • SCIMプロビジョニング入門
        • Microsoft Entra ID
        • Okta
      • 組織リソース
        • セルフホストランナー
  • 請求情報
    • 概要
    • プランのアップグレード
    • クレジット
    • クレジットカードが使えない?
    • サブスクリプションの管理
  • アドオン
    • API Hub
    • Apidog IntelliJ IDEA プラグイン
    • リクエストプロキシ
      • Apidogウェブでのリクエストプロキシ
      • 共有ドキュメントでのリクエストプロキシ
      • Apidogクライアントでのリクエストプロキシ
    • ブラウザ拡張機能
      • Microsoft Edge
      • Chrome
  • アカウント & 設定
    • アカウント設定
    • 言語設定
    • データバックアップ
    • ネットワークプロキシ設定
    • ホットキー
    • Apidogの更新
    • OpenAPIアクセストークンの生成
    • アカウント削除
  • 参考資料
    • Swagger拡張機能
    • Socket通信:パケットの分断と結合
    • 用語の説明
    • よくある質問
    • API-デザインファーストアプローチ
    • Apidog OpenAPI/Swagger仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSONスキーマ
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
  1. APIドキュメント公開

クイック共有

API開発、コミュニケーション、コラボレーションにおいて、APIドキュメントは論理的には標準ですが、実際にはWordやPDF形式のファイルをやり取りする問題があります。このため、チーム間のコミュニケーション効率を向上させるためにオンラインドキュメントが推奨されています。

クイックシェアを作成する#

左側のShare Docsモジュールに切り替えます。
sharing-01.png
+Newをクリックして新しいクイックシェアを作成します。プロジェクトは複数の異なるクイックシェアをサポートしており、異なるコラボレーターに配布できます。チームメンバー全員が、すべてのクイックシェアを確認できます。
create-documentation-share.jpg
新しいシェアのポップアップで、以下のオプションをカスタマイズできます:
Title: このシェアの名前で、Apidogチーム内でのみ表示され、内部識別用であり、共有ドキュメントには表示されません。
Environments: オンラインドキュメントで利用可能な環境を選択します。デフォルトでは環境は選択されていません。複数の環境を選択できます。選択した環境はドキュメント内で読者に表示され、「試してみる」機能を使用する際にリクエストを送信するために使用できます。
ドキュメント作成時にCloud mock環境を選択すると、ドキュメントの読者に対してシンプルなサンドボックス環境を有効にすることと同等です。
Document content: ドキュメントには、Base URLとRequest samplesの2つのオプションコンポーネントがあります。ドキュメントに表示するかどうかを選択できます。
Base URL: 環境で設定されたベースURLです。選択すると、ドキュメント内の各インターフェースに完全なURLが表示されます。選択しない場合、ドキュメント内のURLは「/」で始まります。
Owners: このAPIドキュメントの所有者を表示します。
Request samples: リクエストを呼び出すためのサンプルコードを表示するかどうか。詳細はrequest samplesを参照してください。
エンドポイントの説明の上に「最終更新日時」を表示します。
ドキュメントの最後に「最終更新日時」を表示します。
Allow 'Export', 'Clone' Data: 読者がOAS/Markdown/HTML/Apidog形式でデータをエクスポートおよびクローンすることを許可するかどうか。
Scope to share: このシェアに含めるAPIエンドポイントとMarkdownを選択します。ディレクトリで選択したり、タグでフィルタリングして除外したりできます。また、フォルダ全体を共有することも選択できます。
Security: このドキュメントにアクセスするためにパスワードが必要かどうか、およびこのドキュメントの有効期限を設定できます。有効期限が選択されていない場合、期限切れにはなりません。
Show API Fields: ドキュメントにこれらのフィールドを表示するかどうかを設定できます。含まれるもの:所有者、更新日時、OperationId、オリジナルリンク、認証が必要かどうか。
Language: ここでの言語設定は、ドキュメント内の機能固定テキスト(例:「Query Params」「Request samples」など)に影響しますが、APIドキュメントの内容に書かれたテキストには影響しません。
CORS Proxy: APIドキュメント上でエンドポイントリクエストを処理するためにCORSプロキシサーバーをデプロイおよび設定できます。詳細はこちら。
Advanced settings: ここで「試してみる」ボタンを非表示にする設定や「Powered by Apidog」を非表示にする設定を行えます。

Request samples#

シェアを作成する際に、このモジュールを表示するかどうかを選択できます。
Request samplesをカスタマイズできます。方法は以下の通りです:
1.
Project settings - Feature settings - Endpoint feature settings - Endpoint fieldsでRequest samplesフィールドを有効にします。
2.
次にEndpoint - Editで、Request samplesモジュールが最後に表示されます。
3.
ここでAdd request sampleをクリックして、必要な言語でサンプルを追加できます。すると、ドキュメントに表示されます。
image.png

フォルダ全体を共有する#

クイックシェアはShare entire folderをサポートしています。これは、リンクを共有した後にフォルダ内のドキュメントを追加または削除した場合に、コラボレーターがこれらの変更を同期的に確認できるシナリオに適しています。
Scope to ShareでManual Selectionを選択すると、Share entire folderが表示されます。有効にすると、コラボレーターはフォルダ内のすべてのドキュメントに自動的にアクセスできるようになり、新しいドキュメントを追加するたびに共有設定を調整する必要がなくなります。
sharing-03.png

CORS Proxy#

外部ユーザーとAPIドキュメントをオンラインで共有する際、ユーザーはドキュメント内でエンドポイントを直接テストまたはデバッグしたい場合があります。しかし、これはブラウザでクロスオリジンリソース共有(CORS)問題を引き起こし、リクエストがブロックされる可能性があります。これを解決するために、CORSプロキシを設定できます。このプロキシは、共有ドキュメントからのすべてのエンドポイントリクエストを指定されたリクエストプロキシエージェントを通じてルーティングし、CORS制限を効果的に回避してシームレスなデバッグを可能にします。
CORSプロキシを設定するには、新しい共有ドキュメントを作成する際に設定オプションをクリックするだけです。デフォルトで、ApidogはCloud Agentを提供して、すべての共有ドキュメント間でエンドポイントリクエストを管理します。
configuring-cors-proxy.jpg
ニーズに最適なCORSプロキシオプションを選択します:
choose-desired-cors-proxy.jpg
Cloud Agent: これはApidogのCloud Agentを使用して、共有ドキュメントからのエンドポイントリクエストを処理します。Cloud Agentは内部ネットワーク上のエンドポイントにアクセスできないことに注意してください。
Browser Extensions: このオプションは、ユーザーのブラウザにインストールされたブラウザ拡張機能を使用してリクエストを処理します。ユーザーが拡張機能をインストールしていない場合、エンドポイントリクエストを開始する前にインストールするように促されます。
No Proxy: このオプションを選択すると、リクエストはユーザーのブラウザから直接エンドポイントに送信されます。エンドポイントサーバーの設定がCORSを処理できるように正しく構成されていることを確認し、潜在的な問題を防ぎます。
Self-hosted Request Proxy Agent: これは、チーム内にデプロイされたリクエストプロキシエージェントを使用して、共有ドキュメントからのエンドポイントリクエストを処理することを可能にします。

リンクを共有する#

設定が完了したら、リンクをコピーしてチームメンバーと共有します。
APIドキュメントの表示方法を参照してください。
Previous
CORS プロキシ
Next
可視性設定
Built with