Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. Apidog基本操作
  • 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. Apidog基本操作

さらなる探究

Apidog を始めたばかりの方は、次にその強力な機能に深く掘り下げてみましょう:

API を定義する#

API 仕様のインポート: Apidog はさまざまな API 仕様フォーマットをサポートしており、既存の API を簡単にインポートしたり、確立された標準に準拠したりできます。(詳細を見る)
リクエストから仕様を生成: 既存の API リクエストがある場合、Apidog はそれを解析して API 仕様を生成し、ドキュメント作成を簡素化します。 (詳細を見る)
ブランチでの共同作業: チームはブランチを使って異なる API バージョンや機能に取り組むことができ、効率的なバージョン管理が可能です。 (詳細を見る)

API デバッグの効率化#

リクエストの簡単な構築: Apidog は API 仕様に基づいてリクエストパラメータとボディを自動的に生成し、エラーを減らします。 (詳細を見る)
自動レスポンスチェック: API のレスポンスを即座に仕様と照らし合わせて検証し、一貫性を確保します。(詳細を見る)
Postman のサポート: Postman スクリプトを完全にサポートしており、Apidog への移行がスムーズに行えます。 (詳細を見る)
直接的なデータベース操作: データベースに直接接続し、デバッグ中に CRUD 操作を実行できます。 (詳細を見る)
プログラミング言語との統合: 外部プログラミング言語を統合し、API 開発ワークフローをカスタマイズできます。(詳細を見る)
マイクロサービス対応: Apidog はマイクロサービスアーキテクチャの複雑さをシームレスに処理します。 (詳細を見る)
リアルなテストデータ: 動的でリアルなテストデータを生成し、より効果的な API テストを実現します。 (詳細を見る)
コード生成: API 仕様からリクエストコードとビジネスロジックコードを自動的に生成します。 (詳細を見る)

様々なリクエストの送信#

API のセキュリティ: 認証と認可の方法を簡単に設定し、安全なAPIをテストできます。 (詳細を見る)
GraphQL のサポート: 複雑な GraphQL クエリやミューテーションを簡単に構築して送信できます。 (詳細を見る)
WebSocket を使ったリアルタイムテスト: WebSocket リクエストを使ってリアルタイム通信シナリオをテストできます。(詳細を見る)
レガシーシステムとの統合: Apidog は SOAP および WebService リクエストをサポートし、古いシステムとの連携が可能です。 (詳細を見る)

リアルな Mock データの作成#

自動 Mock データ生成: API 仕様に合わせてリアルな Mock データを生成します。 (詳細を見る)
仕様例の使用: API 仕様に記載された事前定義されたレスポンス例を利用して、一貫性のある Mock データを作成します。(詳細を見る)
レスポンスのカスタマイズ: 特定の Mock シナリオに合わせたカスタムレスポンスを定義します。(詳細を見る)
動的 Mock レスポンス: 入力パラメータに基づいて変化する Mock レスポンスを作成します。 (詳細を見る)
インタラクティブ Mock シナリオ: 入力パラメータを反映した Mock レスポンスを設定し、よりリアルなテストを実施します。 (詳細を見る)
クラウドベースの Mock: クラウドでホストされる Mock サービスを設定し、信頼性の高い常に利用可能な Mock API 環境を提供します。(詳細を見る)

プロフェッショナルな API ドキュメントの公開#

複数の API バージョン: API ドキュメントの複数のバージョンを管理・公開し、スムーズな移行を実現します。 (詳細を見る)
カスタムドメイン: 独自のドメインを使用して API ドキュメントを公開し、ブランドの一貫性を維持します。 (詳細を見る)
カスタマイズされたドキュメント: 自分のニーズに最適なドキュメントページの構造をカスタマイズします。(詳細を見る)
Previous
APIドキュメントを共有
Next
リクエストを送信してAPIとして保存
Built with