Configuration

Mintlify memungkinkan Anda untuk mendefinisikan endpoint API Anda menggunakan kombinasi konfigurasidocs.json, bidang metadata MDX, dan komponen<ParamFields />. Dari endpoint yang didefinisikan, kami menghasilkan playground API, contoh permintaan, dan contoh respons.

1. Konfigurasi API Anda

   Dalam filedocs.json Anda, definisikan URL dasar dan metode auth Anda:

   "api": {
     "mdx": {
       "server": "https://mintlify.com/api", // string array for multiple base URLs
       "auth": {
         "method": "key",
         "name": "x-api-key" // options: bearer, basic, key.
       }
     }
   }

   Jika Anda tidak ingin menampilkan playground API, Anda tidak perlu menyertakan jenis auth. Sembunyikan playground dengan bidang berikut:

   "api": {
     "playground": {
       "display": "none"
     }
   }

   Temukan daftar lengkap konfigurasi APIdi sini.

2. Buat halaman endpoint Anda

   Setiap halaman endpoint API harus memiliki file MDX yang sesuai. Di bagian atas setiap file, definisikan:

   ---
   title: 'Create new user'
   api: 'POST https://api.mintlify.com/user'
   ---

   Anda dapat menentukan parameter path dengan menambahkan nama parameter ke path, dibungkus dengan{}:

   https://api.example.com/v1/endpoint/{userId}

   Jika Anda memilikiserver yang dikonfigurasi didocs.json, Anda dapat menggunakan path relatif seperti/v1/endpoint.

   Anda juga dapat mengganti mode tampilan yang didefinisikan secara global untuk playground API per halaman dengan menambahkanplayground di bagian atas file MDX:

   ---
   title: 'Create new user'
   api: 'POST https://api.mintlify.com/user'
   playground: 'none'

3. Tambahkan endpoint Anda ke dokumentasi Anda

   Tambahkan halaman endpoint Anda ke sidebar dengan menambahkan path ke bidangnavigation didocs.json Anda. Pelajari lebih lanjut tentang menyusun dokumentasi Andadi sini.