Menghubungkan File OpenAPI ke AI

Apidog MCP Server dapat secara langsung membaca file Swagger atau OpenAPI Specification (OAS), sehingga asisten AI dapat bekerja dengan spesifikasi API secara independen dari proyek Apidog atau dokumentasi online.

Prasyarat

Sebelum mengonfigurasi klien MCP, pastikan Anda memiliki:

Node.js (versi 18 atau yang lebih baru, sebaiknya versi LTS terbaru)

IDE yang kompatibel dengan MCP:

Cursor

VS Code + plugin Cline

Editor lain yang mendukung MCP

File Swagger/OpenAPI (URL atau path lokal)

Menyiapkan File OpenAPI Anda

Pastikan Anda memiliki salah satu dari berikut ini:

URL jarak jauh: File OpenAPI yang dapat diakses secara publik (misalnya, https://petstore.swagger.io/v2/swagger.json)

Path file lokal: File OpenAPI di mesin Anda (misalnya, ~/data/petstore/swagger.json)

Format yang didukung: JSON atau YAML

Ikhtisar Konfigurasi

Konfigurasi MCP dasar untuk file OpenAPI:

macOS / Linux

Windows

{
  "mcpServers": {
    "API specification": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=<oas-url-or-path>"
      ]
    }
  }
}

Ganti <oas-url-or-path> dengan:

URL jarak jauh (misalnya, https://petstore.swagger.io/v2/swagger.json)

Path file lokal (misalnya, ~/data/petstore/swagger.json)

Mengonfigurasi MCP di Cursor

Buka Pengaturan MCP

Buka editor Cursor

Klik ikon pengaturan (kanan atas)

Pilih MCP dari menu kiri

Klik + Add new global MCP server

Tambahkan Konfigurasi

Dalam file mcp.json yang terbuka, tambahkan konfigurasi berikut. Ganti https://petstore.swagger.io/v2/swagger.json dengan path file atau URL OpenAPI Anda yang sebenarnya:

macOS / Linux

Windows

{
  "mcpServers": {
    "API specification": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=https://petstore.swagger.io/v2/swagger.json"
      ]
    }
  }
}

Verifikasi Konfigurasi

Uji koneksi dengan meminta AI (dalam mode Agent):

Please fetch API documentation via MCP and tell me how many endpoints exist in the project

Jika AI mengembalikan informasi API yang benar dari file OpenAPI Anda, koneksi berhasil.

Catatan Penting

Bekerja dengan Beberapa File OpenAPI

Untuk menggunakan beberapa file spesifikasi OpenAPI, tambahkan beberapa MCP Server dalam file konfigurasi, masing-masing dengan parameter --oas yang berbeda.

Contoh:

{
  "mcpServers": {
    "Petstore API": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=https://petstore.swagger.io/v2/swagger.json"
      ]
    },
    "Local API": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=~/data/my-api/openapi.yaml"
      ]
    }
  }
}

Persyaratan Path File dan URL

Path file lokal: Pastikan path benar dan file tersebut ada

URL: Pastikan URL dapat diakses secara publik dan mengembalikan file spesifikasi OpenAPI yang valid

Pertimbangan Performa

Jika file OpenAPI Anda berukuran besar atau berisi struktur data yang kompleks, server MCP mungkin memerlukan waktu lebih lama untuk memprosesnya.

Deployment On-Premise

Untuk deployment on-premise, sertakan alamat API server Anda dalam konfigurasi MCP IDE:

{
  "mcpServers": {
    "API specification": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=<oas-url-or-path>",
        "--apidog-api-base-url=<your-server-url>"
      ]
    }
  }
}

Ganti <your-server-url> dengan alamat API server on-premise Anda (dimulai dengan http:// atau https://). Pastikan akses jaringan ke www.npmjs.com.

Sumber Data Lainnya

Hubungkan Spesifikasi API dalam Proyek Apidog ke AI

Hubungkan Dokumentasi API Online yang Dipublikasikan oleh Apidog ke AI

FAQ

Masalah Konfigurasi Windows

Jika konfigurasi standar gagal di Windows, gunakan alternatif ini:

{
  "mcpServers": {
    "API specification": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apidog-mcp-server@latest",
        "--oas=<oas-url-or-path>"
      ]
    }
  }
}

Masalah Versi Node.js

Menghubungkan File OpenAPI ke AI

Prasyarat#

Menyiapkan File OpenAPI Anda#

Ikhtisar Konfigurasi#

Mengonfigurasi MCP di Cursor#

Catatan Penting#

Bekerja dengan Beberapa File OpenAPI#

Persyaratan Path File dan URL#

Pertimbangan Performa#

Deployment On-Premise#

Sumber Data Lainnya#

FAQ#