Bagaimana cara membagikan API kepada kolaborator di Apidog?
Dalam pengembangan, komunikasi, dan kolaborasi API, dokumentasi API secara logis merupakan standar, tetapi dalam praktiknya terdapat masalah berupa pengiriman file dalam format Word atau PDF. Oleh karena itu, dokumen online dianjurkan untuk meningkatkan efisiensi komunikasi antar tim.
Beralih ke modul Share Docs di sisi kiri.Klik "New" untuk membuat Quick share baru. Sebuah proyek mendukung beberapa Quick share yang berbeda, yang dapat didistribusikan kepada kolaborator yang berbeda. Setiap anggota tim dapat melihat semua Quick share yang dibuat oleh semua orang.Dalam popup New Share, 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".
Jika Anda memilih lingkungan Cloud mock saat membuat dokumentasi, ini setara dengan mengaktifkan lingkungan sandbox sederhana bagi pembaca dokumentasi.
Konten dokumen: Dokumen memiliki dua komponen opsional: Base URL dan Contoh 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 "/".
Contoh permintaan: Apakah akan menampilkan kode contoh untuk memanggil permintaan. Lihat Contoh Permintaan untuk detail.
Izinkan ekspor data: Apakah akan mengizinkan pembaca mengekspor 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.
Keamanan: Anda dapat mengatur apakah kata sandi diperlukan untuk mengakses dokumen ini, serta waktu kedaluwarsa dokumen ini. Jika tidak ada waktu kedaluwarsa yang dipilih, dokumen tidak akan pernah kedaluwarsa.
Tampilkan Bidang API: Anda dapat mengatur apakah bidang-bidang 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.
Pengaturan lanjutan: Anda dapat mengatur Sembunyikan Tombol 'Try it out' dan Sembunyikan 'Powered by Apidog' di sini.
Quick share mendukung "membagikan seluruh folder". Ini cocok untuk skenario ketika, setelah membagikan tautan, Anda mungkin telah menambahkan atau menghapus dokumen dalam folder, dan Anda ingin kolaborator dapat melihat perubahan ini secara sinkron.Dalam "Cakupan untuk dibagikan", saat Anda memilih "Pemilihan manual", Anda dapat melihat "membagikan seluruh folder". Jika diaktifkan, kolaborator akan selalu melihat semua dokumen dalam folder, tanpa Anda perlu memodifikasi cakupan berbagi secara manual setelah menambahkan dokumen.
Anda dapat memilih apakah akan menampilkan modul ini saat membuat berbagi. Anda dapat menyesuaikan Contoh permintaan. Berikut caranya:
1.
Di Pengaturan proyek - Pengaturan fitur - Pengaturan fitur endpoint - Bidang endpoint, aktifkan bidang Contoh permintaan.
2.
Kemudian di Endpoint - Edit, modul Contoh permintaan akan muncul di bagian akhir.
3.
Anda dapat mengeklik Tambahkan contoh permintaan di sini untuk menambahkan contoh dalam bahasa yang Anda perlukan. Kemudian contoh tersebut akan muncul dalam dokumentasi.
