Fitur AI

Jadikan dokumentasi API Anda siap untuk AI dengan fitur AI yang memungkinkan integrasi lancar dengan asisten AI dan alat pengembangan. Fitur-fitur ini membantu developer memanfaatkan alat AI seperti Cursor, Cline, dan IDE bertenaga AI lainnya untuk mempercepat integrasi API dan pembuatan kode.

Persyaratan Versi

Versi Apidog harus ≥ 2.7.2 untuk mengakses fitur-fitur ini.

Untuk mengaktifkan fitur-fitur ini: Buka Publish Docs → Publish Docs Sites → AI Features.

Ask AI

Fitur ini mengaktifkan fitur pencarian percakapan pada halaman dokumentasi Anda. Anda dapat menghubungkan AI Assistant dari Algolia untuk menggunakan fitur ini. Anda dapat mempelajari selengkapnya tentang fitur ini di bagian Ask AI pada halaman Documentation Search.

Aktifkan MCP (Model Context Protocol)

Ketika diaktifkan, tombol "MCP" akan muncul di dokumentasi Anda, yang memandu pengguna tentang cara menghubungkan dokumentasi API Anda ke IDE yang mendukung MCP seperti Cursor dan Cline. Ini memungkinkan Agentic AI membantu pembuatan kode langsung dari dokumentasi API Anda.

Pelajari Selengkapnya

Untuk instruksi penyiapan terperinci, baca: Connect Online API Documentation Published by Apidog to AI via Apidog MCP Server.

Aktifkan Copy Page

Ketika diaktifkan, tombol "Copy page" akan muncul di dokumentasi Anda, yang memungkinkan pengguna menyalin halaman saat ini dalam format Markdown—ideal untuk ditempelkan ke percakapan AI.

Aktifkan llms.txt

Ketika diaktifkan, file Markdown llms.txt secara otomatis dibuat di direktori root situs dokumentasi Anda. File ini berisi tautan ke setiap halaman Markdown dengan deskripsi ringkas, sehingga memudahkan asisten AI menemukan dan menavigasi dokumentasi Anda.

Contoh:

Cara Asisten AI Menggunakan llms.txt

Ada dua metode umum untuk menggunakan llms.txt dan file Markdown terkait:

1. Bagikan tautan Markdown dengan asisten AI yang dapat mengakses URL

Setiap halaman dokumentasi online yang dipublikasikan melalui Apidog memiliki versi Markdown. Anda dapat:

Menambahkan ".md" ke URL dokumen apa pun (misalnya, https://example.apidog.io/page.md)

Atau mengeklik "View as Markdown" di dokumentasi online

Asisten AI dengan kemampuan Web Browsing dapat menggunakan URL ".md" ini untuk mengambil dokumentasi ringkas.

Misalnya, di Cursor, Anda dapat meminta "Understand this info: @https://zojphlasi1.apidog.io/find-pet-by-id-12888653e0.md and help me generate a TypeScript client".

Format Prompt

Format prompt harus mengikuti aturan khusus alat AI yang digunakan. Misalnya, di Cursor, URL harus diawali dengan @ agar dikenali sebagai konteks.

2. Salin konten Markdown untuk asisten AI yang tidak dapat mengakses URL

Jika asisten AI tidak dapat mengakses konten melalui URL, Anda perlu menyalin dan menempelkan konten Markdown secara manual.

Klik tombol "Copy Page" di dokumentasi online untuk mendapatkan konten halaman saat ini dalam format Markdown, lalu tempelkan ke percakapan Anda dengan asisten AI.

Contoh prompt:

"Berdasarkan definisi endpoint ini, buatkan client TypeScript: (tempelkan konten yang disalin di sini)."

FAQ

Apakah mengaktifkan llms.txt memengaruhi keamanan dokumentasi?

Tidak. llms.txt hanya menyertakan konten yang sudah dipublikasikan secara publik. Ini hanya mengonversi HTML ke Markdown dan tidak mengekspos dokumentasi privat atau yang belum dipublikasikan. Jika kontrol akses (kata sandi, daftar izin IP, daftar izin email, dll.) dikonfigurasi, pengguna tetap harus lolos autentikasi untuk mengakses llms.txt dan file Markdown.

Bisakah saya menggunakan llms.txt jika dokumentasi saya dilindungi oleh kata sandi, IP, atau daftar izin email?？

Mengapa saya tidak melihat tombol `Copy Page` di Apidog App?

Saya telah mengaktifkan fitur 'Web Search' untuk asisten AI saya. Mengapa fitur tersebut tidak dapat membaca konten halaman web melalui URL?

Apa yang harus saya lakukan jika asisten AI gagal mengakses file Markdown melalui URL?

Apakah saya perlu melakukan hal lain setelah mengaktifkan llms.txt?

Bagaimana cara memverifikasi bahwa llms.txt berfungsi dengan benar?

Ask AI#

Aktifkan MCP (Model Context Protocol)#

Aktifkan Copy Page#

Aktifkan llms.txt#

Cara Asisten AI Menggunakan llms.txt#

FAQ#

Ask AI

Aktifkan MCP (Model Context Protocol)

Aktifkan Copy Page

Aktifkan llms.txt

Cara Asisten AI Menggunakan llms.txt

FAQ