Setup

Tambahkan file spesifikasi AsyncAPI

Untuk mulai membuat halaman untuk websocket Anda, pastikan Anda memiliki dokumen skema AsyncAPI yang valid dalam format JSON atau YAML yang mengikutispesifikasi AsyncAPI. Skema Anda harus mengikuti spesifikasi AsyncAPI 3.0+.

Untuk memastikan skema AsyncAPI Anda valid, Anda dapat menempelkannya ke AsyncAPI Studio

Isi otomatis halaman websocket

Anda dapat menambahkan bidangasyncapi ke tab atau grup mana pun dalam navigasidocs.json. Bidang ini dapat berisi path ke dokumen skema AsyncAPI di repo dokumentasi Anda, URL dokumen skema AsyncAPI yang di-host, atau array tautan ke dokumen skema AsyncAPI. Mintlify akan secara otomatis menghasilkan halaman untuk setiap channel websocket AsyncAPI.

Contoh dengan Tab:

Local File

"navigation": {
  "tabs": [
    {
        "tab": "API Reference",
        "asyncapi": "/path/to/asyncapi.json"
    }
  ]
}

Contoh dengan Grup:

"navigation": {
  "tabs": [
    {
      "tab": "AsyncAPI",
      "groups": [
        {
          "group": "Websockets",
          "asyncapi": {
            "source": "/path/to/asyncapi.json",
            "directory": "api-reference"
          }
        }
      ]
    }
  ]
}

Bidang direktori bersifat opsional. Jika tidak ditentukan, file-file akan ditempatkan di folderapi-reference dari repo dokumentasi.

Halaman Channel

Jika Anda ingin lebih banyak kontrol atas bagaimana Anda mengurutkan channel Anda atau jika Anda hanya ingin merujuk ke satu channel, Anda dapat membuat file MDX dengan bidangasyncapi di frontmatter.

---
title: "Websocket Channel"
asyncapi: "/path/to/asyncapi.json channelName"
---