AspNetCore.RapiDoc

Umum

Milik	Keterangan	Bawaan
RoutePrefix	Awalan rute untuk mengakses rapidoc	"Rapidoc"
Specurl	URL spec openapi untuk dilihat	string.empty
Headingtext	Heading Text di sudut kiri atas	"Rapidoc"
Sorttags	Diizinkan: Benar | PALSU Untuk daftar tag dalam urutan alfabet, jika tidak tag akan dipesan berdasarkan bagaimana itu ditentukan di bawah bagian tag dalam spec.	PALSU
SortendPointsby	Diizinkan: Path | Metode | ringkasan Urutkan titik akhir dalam setiap tag berdasarkan jalur, metode atau ringkasan | Contoh	jalur
Gotopath	Lokasi awal pada dokumen (diidentifikasi dengan metode dan jalur) di mana Anda ingin mengejar spek dimuat. Misalnya jika Anda ingin menggulir untuk mendapatkan/pengguna/login, Anda harus menyediakan lokasi sebagai new PathInfo(SubmitMethod.Get,"/user/login")	batal
FillRequestFieldsWithExample	Diizinkan: Benar | PALSU Bidang permintaan akan diisi dengan nilai contoh (jika disediakan dalam spec)	BENAR

Opsi Warna dan Font UI

Milik	Keterangan	Bawaan
Tema	Adalah tema dasar, yang digunakan untuk menghitung warna untuk berbagai komponen UI. 'Tema', 'BG-Color' dan 'Text-Color' adalah atribut dasar untuk menghasilkan tema khusus	Gelap
Bgcolor	Warna untuk latar belakang utama	Tema Gelap #333 Tema ringan #fff
TextColor	Warna untuk teks	Tema Gelap #BBB Tema Cahaya #444
Headercolor	Warna untuk latar belakang header	#444444
Primarycolor	Warna pada berbagai kontrol seperti tombol, tab	#Ff791a
Loadfonts	Rapidoc akan mencoba memuat font dari CDN, jika ini tidak dimaksudkan, maka atur ini ke false.	BENAR
Regulerfont	Nama font yang akan digunakan untuk teks biasa	"Open Sans", Avenir, "Segoe Ui", Arial, sans-serif
Monofont	Nama font yang akan digunakan untuk teks mono-spaced	Monaco, 'Andale Mono', 'Roboto Mono', 'Consolas' Monospace
Fontsize	Menetapkan ukuran font relatif untuk seluruh dokumen	bawaan

Opsi bilah navigasi

Milik	Keterangan	Bawaan
Usepathinnavbar	Setel untuk menunjukkan jalur API di bilah navigasi alih -alih ringkasan/deskripsi | Contoh	PALSU
NAVBGCOLOR	Contoh Warna Latar Belakang Bar Navigasi
Navbgimage	URL Contoh Latar Belakang Bar Navigasi	string.empty
NavbgimageSize	Ukuran gambar latar belakang navigasi (sama seperti properti ukuran latar belakang CSS)	Mobil
NavbgimageRepeat	Image latar belakang navigasi mengulangi (sama seperti properti latar belakang CSS)	Norepeat
NavTextColor	Warna teks navigasi	tidak ada warna
Navhoverbgcolor	Warna latar belakang item navigasi pada mouse-over	tidak ada warna
NavhovertextColor	Warna teks item navigasi pada mouse-over	tidak ada warna
NAVACCENTCOLOR	Indikator item yang dipilih saat ini	tidak ada warna
Navitemspacing	Mengontrol contoh jarak item navigasi	Bawaan

Opsi tata letak UI

Milik	Keterangan	Bawaan
Tata letak	Tata letak membantu dalam penempatan bagian permintaan/respons. Dalam tata letak kolom, bagian permintaan dan respons ditempatkan satu di bawah yang lain, dalam tata letak baris mereka ditempatkan berdampingan. Atribut ini hanya berlaku ketika lebar perangkat lebih dari 768px dan gaya render adalah 'tampilan'.	Baris
Renderstyle	Menentukan tampilan API-DOCS. Saat ini ada tiga mode yang didukung Lihat Ramah untuk Menjelajah Cepat (Perluas/Kubur Bagian yang Anda minati) BACA BACA UNTUK MEMBACA (seperti halaman web berkelanjutan) Fokus mirip dengan dibaca tetapi berfokus pada satu titik akhir pada satu waktu (baik untuk spesifikasi besar) Baca lebih lanjut yang cocok untuk membaca lebih ramah untuk menjelajahi cepat	Melihat
Onnavtagclick	Hanya berlaku untuk gaya render yang terfokus. Ini menentukan perilaku mengklik pada tag di bilah navigasi. Ini dapat memperluas tag-collapse atau membawa Anda ke halaman deskripsi tag.	ExpandCollapse
Skema	Dua cara berbeda untuk menampilkan scemas objek dalam tanggapan dan meminta badan	Pohon
SkemaExpandlevel	Skema diperluas secara default, gunakan atribut ini untuk mengontrol berapa banyak level dalam skema yang harus diperluas	999
SCHEMADESSCRIPTEDEKSED	Kendala dan deskripsi informasi bidang dalam skema runtuh untuk hanya menampilkan baris pertama. Atur ke true jika Anda ingin mereka berkembang sepenuhnya	PALSU
Schemahidereadonly	SKEMA BACA-SAN BACA DALAM SKEMA SELALU TERSEDI TETAPI TETAP DILAKUKAN sebagai tanggapan. Jika Anda tidak ingin menyembunyikan bidang baca saja atau menyembunyikannya berdasarkan tindakan, Anda dapat mengonfigurasi pengaturan ini ke 'tidak pernah' atau kombinasi pos | put | tambalan untuk menunjukkan di mana harus bersembunyi Skema di bagian respons tidak terpengaruh oleh pengaturan ini.	Selalu
Schemahidewriteonly	Kendala dan deskripsi informasi bidang dalam skema runtuh untuk hanya menampilkan baris pertama. Atur ke true jika Anda ingin mereka berkembang sepenuhnya	Selalu
Defaultschematab	Skema ditampilkan dalam dua tab - model dan contoh. Opsi ini memungkinkan Anda untuk memilih tab default yang ingin Anda aktifkan	Model
ResponseareAheight	Nilai tinggi CSS yang valid seperti 400px, 50%, 60VH dll - Gunakan nilai ini untuk mengontrol ketinggian TextArea Respons	"300px"

Opsi Bagian

Milik	Keterangan	Bawaan
Showinfo	Tampilkan/Sembunyikan Bagian Info Dokumen Bagian info berisi informasi tentang spek, seperti judul dan deskripsi spec, versi, ketentuan layanan dll. Dalam situasi tertentu Anda mungkin tidak perlu menunjukkan bagian ini. Misalnya Anda menanamkan elemen ini di dalam dokumen bantuan lain. Kemungkinannya adalah, Doc Bantuan mungkin sudah memiliki info ini, dalam hal ini Anda mungkin ingin menyembunyikan bagian ini.	BENAR
Infodescriptionheadinginnavbar	Sertakan header dari info -> Bagian Deskripsi ke bilah navigasi (hanya berlaku untuk mode baca) Akan mendapatkan header dari markdown in info - description (H1 dan H2) ke menu di sebelah kiri (dalam mode baca) bersama dengan tautan ke mereka. Opsi ini memungkinkan pengguna untuk menambahkan item bilah navigasi menggunakan markdown	PALSU
Pameran	Tampilkan/Sembunyikan Bagian Komponen Baik dalam dokumen maupun menu (hanya tersedia dalam gaya render yang terfokus) Akan menampilkan bagian komponen bersama dengan skema, tanggapan, contoh, permintaanbodi, header, schemschemes, tautan, dan panggilan balik juga akan ditampilkan di menu di sebelah kiri (dalam mode baca)	PALSU
Showheader	Tunjukkan/sembunyikan header. Jika Anda tidak ingin pengguna Anda membuka spesifikasi API lainnya, selain yang saat ini, maka atur atribut ini ke false	BENAR
AllowAuthentication	Fitur otentikasi, memungkinkan pengguna untuk memilih salah satu mekanisme otentikasi yang tersedia di spec. Ini bisa berupa http-basic, http-bearer atau api-key. Jika Anda tidak ingin pengguna Anda menjalani proses otentikasi, alih-alih ingin mereka menggunakan API-Key yang telah dihasilkan, maka Anda dapat menyembunyikan bagian otentikasi dengan mengatur atribut ini ke False dan memberikan detail API-key menggunakan berbagai API-Key-???? atribut	BENAR
Mengizinkan UNTUK UNTUK	Jika disetel ke 'false', pengguna tidak akan dapat memuat URL spec apa pun dari UI	PALSU
Mengizinkan Umpan Besar	Jika diatur ke 'false', pengguna tidak akan dapat memuat file spesifikasi apa pun dari drive lokal. Atribut ini hanya berlaku saat lebar perangkat lebih dari 768px, jika tidak fitur ini tidak tersedia	PALSU
Memungkinkan penelitian	Memberikan penyaringan API cepat	BENAR
Izinkan penelitian	Menyediakan fungsionalitas pencarian lanjutan, untuk mencari melalui jalur API, deskripsi API, API-parameter dan respons API	BENAR
Ijinkan	Fitur 'coba' memungkinkan Anda melakukan panggilan istirahat ke server API. Untuk menonaktifkan fitur ini, atur ke false.	BENAR
Mengizinkan Certerverselection	Jika diatur ke 'false', pengguna tidak akan dapat melihat atau memilih API Server (daftar server akan disembunyikan, namun pengguna akan dapat melihat URL server di dekat tombol 'Coba', untuk mengetahui terlebih dahulu di mana coba akan mengirim permintaan). URL yang ditentukan dalam atribut server-URL akan digunakan jika ditetapkan, jika tidak server pertama dalam file spesifikasi API akan digunakan.	BENAR
TEPADCHEMADSCRIPTIONEXPANDTOGGLE	Izinkan atau sembunyikan kemampuan untuk memperluas/runtuhnya deskripsi lapangan dalam skema	BENAR

Opsi Server API

Milik	Keterangan	Bawaan
Serverurl	OpenAPI Spec memiliki ketentuan untuk menyediakan URL server. UI akan mencantumkan semua URL server yang disediakan dalam spec. Pengguna kemudian dapat memilih satu URL yang ia maksudkan untuk mengirim panggilan API saat mencoba API. Namun, jika Anda ingin menyediakan server API sendiri yang tidak terdaftar dalam spec, Anda dapat menggunakan properti ini untuk menyediakannya. Sangat membantu dalam kasus -kasus di mana spec yang sama dibagi antara beberapa lingkungan mengatakan dev dan tes dan masing -masing memiliki server API mereka sendiri.	string.empty
Defaultapiserver	Jika Anda memiliki beberapa API-Server yang tercantum dalam SPEC, gunakan atribut ini untuk memilih server API default, di mana semua panggilan API akan GOTO. Ini dapat diubah nanti dari UI	string.empty
Apikeyname	Nama kunci API yang akan dikirim saat mencoba API	string.empty
Apikeylocation	Menentukan bagaimana Anda ingin mengirim api-key	tidak diatur
Apikeyvalue	Nilai kunci API yang akan dikirim saat mencoba API. Ini juga dapat disediakan/ditimpa dari UI	string.empty
Fetchcredentials	Mengaktifkan kredensial/cookie yang lewat dalam panggilan domain silang, sebagaimana didefinisikan dalam standar pengambilan, dalam permintaan CORS yang dikirim oleh browser	tidak diatur

Opsi slot

Milik	Keterangan	Bawaan
Logo	Menggantikan logo default header dengan URL yang ditentukan	string.empty
Logowidth	Menentukan lebar logo logo khusus, tidak berlaku untuk logo default	36
LOGOHEIGHT	Menentukan ketinggian logo logo khusus, tidak berlaku untuk logo default	36
Logopadding	Menentukan bantalan logo logo khusus, tidak berlaku untuk logo default	0
Navlogo	Menambahkan logo navigasi di atas bilah navigasi samping dengan URL yang disediakan, hanya tersedia dalam mode baca	string.empty
Navlogowidth	Menentukan lebar logo navigasi dari logo khusus, hanya tersedia dalam mode baca	36
Navlogoheight	Menentukan ketinggian logo navigasi logo khusus, hanya tersedia dalam mode baca	36
Navlogopadding	Menentukan bantalan logo navigasi dari logo khusus, hanya tersedia dalam mode baca	0