Berbagi Cepat

Kolaborasi API yang efektif memerlukan berbagi dokumentasi yang lancar. Berbagi Cepat menghilangkan ketidakefisienan dalam mengirimkan file Word atau PDF dengan menyediakan tautan dokumentasi online secara instan. Fitur ini memungkinkan komunikasi cepat antartim, sehingga Anda dapat membagikan endpoint API tertentu kepada kolaborator sambil tetap mempertahankan kendali atas akses, visibilitas, dan kedaluwarsa.

Prasyarat

Sebelum membuat Berbagi Cepat, pastikan Anda memiliki:

Akun Apidog dengan akses ke sebuah proyek

Endpoint API atau dokumentasi untuk dibagikan

(Opsional) Lingkungan yang telah dikonfigurasi jika Anda ingin pembaca menguji endpoint

Membuat Berbagi Cepat

Beralih ke modul Publish Docs pada sidebar kiri.

CleanShot 2025-12-29 pukul 17.18.46@2x.png

Klik +New untuk membuat Berbagi Cepat baru. Sebuah proyek mendukung beberapa Berbagi Cepat, yang dapat didistribusikan kepada kolaborator yang berbeda. Semua anggota tim dapat melihat Berbagi Cepat yang dibuat oleh siapa pun di tim.

Opsi Konfigurasi

Dalam dialog Berbagi Baru, Anda dapat menyesuaikan opsi berikut:

Judul: Nama berbagi ini, hanya terlihat di dalam tim Apidog, digunakan untuk identifikasi internal, tidak terlihat dalam dokumentasi yang dibagikan.

Lingkungan: Pilih lingkungan yang tersedia dalam dokumen online. Secara default, tidak ada lingkungan yang dipilih. Anda dapat memilih beberapa lingkungan. Lingkungan yang dipilih akan terlihat oleh pembaca dalam dokumentasi dan dapat digunakan untuk mengirim permintaan saat menggunakan "Try it out".

Lingkungan Cloud Mock

Jika Anda memilih lingkungan Cloud mock saat membuat dokumentasi, Anda menyediakan lingkungan sandbox sederhana bagi pembaca untuk menguji API tanpa memengaruhi sistem produksi.

Konten dokumen: Dokumen memiliki dua komponen opsional: Base URL dan Sampel permintaan. Anda dapat memilih apakah akan menampilkannya dalam dokumen.

Base URL: Ini adalah URL dasar yang ditetapkan dalam lingkungan. Jika dipilih, setiap antarmuka dalam dokumen akan menampilkan URL lengkap; jika tidak dipilih, URL dalam dokumen akan dimulai dengan "/".

Pemilik: Menampilkan pemilik dokumentasi API ini.

Sampel permintaan: Apakah akan menampilkan kode contoh untuk memanggil permintaan. Lihat sampel permintaan untuk detail.

Tampilkan waktu 'Terakhir Diubah' di atas deskripsi endpoint.

Tampilkan waktu 'Terakhir Diubah' di akhir dokumentasi.

Izinkan Data 'Export', 'Clone': Apakah akan mengizinkan pembaca mengekspor & mengkloning data dalam format OAS/Markdown/HTML/Apidog.

Cakupan untuk dibagikan: Pilih endpoint API dan Markdown mana yang akan disertakan dalam berbagi ini. Anda dapat memilih berdasarkan direktori atau filter dan mengecualikan berdasarkan tag. Anda juga dapat memilih untuk membagikan seluruh folder.

Keamanan: Anda dapat menetapkan apakah kata sandi diperlukan untuk mengakses dokumen ini, serta waktu kedaluwarsa dokumen ini. Jika tidak ada waktu kedaluwarsa yang dipilih, dokumen tidak pernah kedaluwarsa.

Tampilkan Kolom API: Anda dapat menetapkan apakah kolom-kolom ini ditampilkan dalam dokumen. Termasuk: Pemilik, Waktu pembaruan, OperationId, Tautan asli, Otorisasi Diperlukan.

Bahasa: Pengaturan bahasa di sini akan memengaruhi teks tetap fungsional dalam dokumen, seperti "Query Params" "Request samples", dan sebagainya, tetapi tidak akan memengaruhi teks yang ditulis dalam konten dokumentasi API.

Proxy CORS: Anda dapat men-deploy dan mengonfigurasi server proxy CORS untuk menangani permintaan endpoint pada dokumentasi API. Pelajari selengkapnya.

Pengaturan Lanjutan: Konfigurasikan opsi seperti Sembunyikan Tombol 'Try it out' dan Sembunyikan 'Powered by Apidog'.

Sampel Permintaan

Anda dapat memilih apakah akan menampilkan sampel kode permintaan saat membuat berbagi.
Cara menyesuaikan sampel permintaan:

Di Settings → Feature settings → Endpoint feature settings → Endpoint fields, aktifkan kolom Request samples

Di Endpoint → Edit, modul Request samples akan muncul di bagian akhir

Klik Custom Request Code Samples untuk menambahkan sampel dalam bahasa yang Anda inginkan

CleanShot 2025-12-29 pukul 17.21.25@2x.png

Bagikan Seluruh Folder

Berbagi Cepat mendukung Share entire folder, yang ideal untuk skenario ketika Anda terus menambahkan atau menghapus dokumen setelah berbagi. Ketika diaktifkan, kolaborator secara otomatis mengakses semua dokumentasi dalam folder tanpa mengharuskan Anda menyesuaikan pengaturan berbagi untuk setiap dokumen baru.

Di bagian Scope to Share, pilih Manual Selection untuk melihat opsi Share entire folder. Ketika diaktifkan, kolaborator secara otomatis mengakses semua dokumentasi dalam folder.

Konfigurasi Proxy CORS

Saat membagikan dokumentasi API kepada pengguna eksternal, mereka mungkin mengalami masalah Cross-Origin Resource Sharing (CORS) saat menguji endpoint langsung di browser. Proxy CORS menyelesaikan hal ini dengan merutekan permintaan melalui agen proxy yang ditentukan, melewati pembatasan CORS browser, dan memungkinkan pengujian API yang lancar.

Untuk mengonfigurasi proxy CORS, klik opsi pengaturan saat membuat dokumentasi bersama yang baru. Secara default, Apidog menawarkan Cloud Agent untuk mengelola permintaan endpoint di seluruh dokumentasi bersama.

Opsi Proxy CORS

Pilih opsi proxy CORS yang paling sesuai dengan kebutuhan Anda:

Cloud Proxy: Menggunakan Cloud Agent milik Apidog untuk menangani permintaan endpoint. Catatan: Cloud Agent tidak dapat mengakses endpoint pada jaringan internal

Ekstensi Browser: Menggunakan ekstensi browser yang dipasang di browser pengguna. Pengguna tanpa ekstensi akan diminta untuk memasangnya sebelum membuat permintaan

Tanpa Proxy: Permintaan dikirim langsung dari browser pengguna. Pastikan server endpoint Anda dikonfigurasi untuk menangani CORS dengan benar

Self-hosted Request Proxy Agent: Gunakan Self-hosted Request Proxy Agent yang di-deploy dalam infrastruktur Anda untuk menangani permintaan endpoint

Prasyarat#

Membuat Berbagi Cepat#

Opsi Konfigurasi#

Sampel Permintaan#

Bagikan Seluruh Folder#

Konfigurasi Proxy CORS#

Opsi Proxy CORS#

Prasyarat

Membuat Berbagi Cepat

Opsi Konfigurasi

Sampel Permintaan

Bagikan Seluruh Folder

Konfigurasi Proxy CORS

Opsi Proxy CORS