Konfigurasi Inti
Komponen
Halaman API
- Overview
- OpenAPI
- AsyncAPI
- MDX
- Troubleshooting
Autentikasi dan Personalisasi
- Authentication
- Partial authentication
- Personalization
- Authentication vs personalization
- Pengaturan Autentikasi
- Pengaturan Personalisasi
- Sending data
Panduan
- Migration
- Mcp
- Translations
- Monorepo
- React components
- Custom scripts
- Seo
- Hidden pages
- Broken links
- Subdirektori Kustom
- Akses Dashboard
Integrasi
- Analitik
- SDK
- Dukungan
- Privasi
Kontrol Versi dan CI/CD
Support
Widget dasbor
Kirim pesan kepada kami dari dasbor Anda. Pilih Support di sidebar dasbor Anda.
Email Kami
Jika Anda tidak dapat mengakses dasbor Anda, email kami di support@mintlify.com.
Tanya AI
Bergabunglah dengan komunitas kami dan tanyakan asisten AI kami yang telah dilatih dengan dokumentasi kami.
YouTube
Tonton tutorial dan panduan di channel YouTube kami.
Pertanyaan yang Sering Diajukan
Aplikasi GitHub bisa bermasalah dan mereset koneksi adalah cara yang bagus untuk menyelesaikan masalah.
Copot pemasangan aplikasi Mintlify melalui GitHub
- Di GitHub, pergi ke installations dan pilih Configure di sebelah aplikasi Mintlify. Gulir ke bawah dan pilih Uninstall.
- Pergi ke Authorized GitHub Apps dan pilih Revoke di sebelah aplikasi Mintlify.
Pasang ulang aplikasi Mintlify
- Di dasbor Mintlify Anda, pergi ke Git Settings dan pasang aplikasi GitHub.
- Otorisasi akun Anda di bagian My Profile di dasbor Anda.
Halaman API itu rumit. Akibatnya, ada banyak hal yang bisa salah. Berikut adalah daftar masalah umum yang sering dihadapi pelanggan:
Dalam skenario ini, kemungkinan besar Mintlify tidak dapat menemukan dokumen OpenAPI Anda atau dokumen OpenAPI Anda tidak valid.
Menjalankan mint dev
secara lokal seharusnya mengungkapkan beberapa masalah ini.
Untuk memverifikasi bahwa dokumen OpenAPI Anda akan lulus validasi:
- Jalankan
mint openapi-check <openapiFilenameOrUrl>
di CLI Anda. - Validasi spesifikasi OpenAPI Anda dengan Swagger Editor.
Selain itu, Mintlify tidak mendukung OpenAPI 2.0. Jika dokumen Anda menggunakan OpenAPI 2.0, Anda mungkin mengalami masalah ini. Anda dapat mengkonversi dokumen Anda dengan Swagger Editor.
Ini biasanya disebabkan oleh kesalahan ejaan pada bidang openapi
di metadata halaman. Pastikan bahwa metode HTTP dan path cocok persis dengan metode HTTP dan path dalam dokumen OpenAPI.
Berikut adalah contoh bagaimana hal-hal bisa salah:
---
openapi: "GET /users/{id}/"
---
paths:
"/users/{id}":
get: ...
Perhatikan bahwa path di bidang openapi
memiliki garis miring di akhir, sedangkan path di dokumen OpenAPI tidak.
Masalah umum lainnya adalah kesalahan ejaan nama file. Jika Anda menentukan dokumen OpenAPI tertentu di bidang openapi
, pastikan nama filenya benar. Misalnya, jika Anda memiliki dua dokumen OpenAPI openapi/v1.json
dan openapi/v2.json
, metadata Anda mungkin terlihat seperti ini:
---
openapi: "v1 GET /users/{id}"
---
Jika Anda memiliki domain kustom yang dikonfigurasi, ini bisa menjadi masalah dengan reverse proxy Anda. Secara default, permintaan yang dibuat melalui API Playground dimulai dengan permintaan POST
ke path /api/request
pada situs dokumen. Jika reverse proxy Anda dikonfigurasi untuk hanya mengizinkan permintaan GET
, maka semua permintaan ini akan gagal. Untuk memperbaikinya, konfigurasikan reverse proxy Anda untuk mengizinkan permintaan POST
ke path /api/request
.
Atau, jika reverse proxy Anda mencegah Anda menerima permintaan POST
, Anda dapat mengonfigurasi Mintlify untuk mengirim permintaan langsung ke backend Anda dengan pengaturan api.playground.proxy
di docs.json
. Lihat configurations for the API playground untuk informasi lebih lanjut. Ini kemungkinan akan mengharuskan Anda untuk mengonfigurasi CORS di server Anda, karena permintaan ini sekarang akan datang langsung dari browser pengguna Anda.
Periksa apakah Anda memiliki /api
di URL. Ini adalah folder yang dicadangkan di lingkungan produksi, yang menghasilkan error 404.
Kami mendukung jenis SVG tertentu, yang disebut JSX, dan karenanya gambar perlu dikonversi.
- Gunakan SVGR converter untuk menghasilkan kode SVG yang kompatibel dengan JSX.
- Salin kode di dalam tag
<svg/>
.
- Tempel kode ke dalam kartu Anda. Pastikan Anda hanya menyalin dan menempel kode di dalam tag
<svg/>
. - Anda mungkin perlu mengurangi tinggi dan lebar untuk membuat gambar pas.
Kami berusaha sebaik mungkin untuk menanggapi semua permintaan dalam waktu 24 jam tetapi penundaan mungkin terjadi selama waktu sibuk.
Apakah halaman ini membantu?