หน้าแรก>ซอร์สโค้ด ASP>หมวดหมู่อื่นๆ
ดาวน์โหลด

ทั่วไป

คุณสมบัติ คำอธิบาย ค่าเริ่มต้น
RoutePrefix คำนำหน้าเส้นทางสำหรับการเข้าถึง Rapidoc "Rapidoc"
specurl URL ของ Spec OpenAPI เพื่อดู String.empty
หัวเรื่อง หัวเรื่องข้อความที่มุมบนซ้าย "Rapidoc"
Sorttags อนุญาต: จริง | เท็จ
ในการแสดงรายการแท็กตามลำดับตัวอักษรมิฉะนั้นแท็กจะถูกสั่งซื้อตามวิธีที่ระบุไว้ภายใต้ส่วนแท็กในข้อมูลจำเพาะ		 เท็จ
sortendpointsbys อนุญาต: เส้นทาง | วิธีการ | สรุป
เรียงลำดับจุดสิ้นสุดภายในแต่ละแท็กโดยเส้นทางวิธีหรือสรุป | ตัวอย่าง		 เส้นทาง
gotopath ตำแหน่งเริ่มต้นในเอกสาร (ระบุด้วยวิธีและเส้นทาง) ซึ่งคุณต้องการไปหลังจากโหลดสเป็ค
ตัวอย่างเช่นหากคุณต้องการเลื่อนเพื่อรับ/ผู้ใช้/เข้าสู่ระบบคุณควรระบุตำแหน่งเป็น new PathInfo(SubmitMethod.Get,"/user/login")		 โมฆะ
Fillrequestfieldswithexample อนุญาต: จริง | เท็จ
ฟิลด์คำขอจะถูกกรอกด้วยค่าตัวอย่าง (ถ้าระบุไว้ในข้อมูลจำเพาะ)		 จริง

ตัวเลือกสีและฟอนต์ UI

คุณสมบัติ คำอธิบาย ค่าเริ่มต้น
ธีม เป็นธีมพื้นฐานซึ่งใช้สำหรับการคำนวณสีสำหรับส่วนประกอบ UI ต่างๆ 'ธีม', 'BG-Color' และ 'Text-Color' เป็นคุณลักษณะพื้นฐานสำหรับการสร้างธีมที่กำหนดเอง มืด
สี bgcolor สีสำหรับพื้นหลังหลัก ธีมมืด #333
ธีมเบา #FFF
Textcolor สีสำหรับข้อความ ธีมมืด #BBB
ธีมแสง #444
สีน้ำตาลศีรษะ สีสำหรับพื้นหลังของส่วนหัว #444444
PrimaryColor สีบนตัวควบคุมต่าง ๆ เช่นปุ่มแท็บ #ff791a
โหลด fonts Rapidoc จะพยายามโหลดแบบอักษรจาก CDN หากไม่ได้ตั้งใจให้ตั้งค่าเป็นเท็จ จริง
เป็นประจำ ชื่อตัวอักษรที่จะใช้สำหรับข้อความปกติ "Open Sans", Avenir, "Segoe Ui", Arial, Sans-Serif
โมโนฟอนท์ ชื่อตัวอักษรที่จะใช้สำหรับข้อความที่เว้นระยะเดียว โมนาโก, 'Andale Mono', 'Roboto Mono', 'Consolas' Monospace
แบบอักษร ตั้งค่าขนาดตัวอักษรสัมพัทธ์สำหรับเอกสารทั้งหมด ค่าเริ่มต้น

ตัวเลือกแถบการนำทาง

คุณสมบัติ คำอธิบาย ค่าเริ่มต้น
Usepathinnavbar ตั้งค่าจริงเพื่อแสดงเส้นทาง API ในแถบการนำทางแทนบทสรุป/คำอธิบาย | ตัวอย่าง เท็จ
navbgcolor ตัวอย่างสีพื้นหลังของแถบนำทาง
navbgimage URL ของตัวอย่างพื้นหลังของแถบการนำทาง String.empty
navbgimagesize ขนาดภาพพื้นหลังของแถบการนำทาง (เหมือนกับคุณสมบัติขนาดพื้นหลัง CSS) รถยนต์
navbgimagerepeat ภาพพื้นหลังของแถบการนำทางทำซ้ำ (เหมือนกับคุณสมบัติการทำซ้ำพื้นหลัง CSS) น่านน้ำ
Navtextcolor สีข้อความของแถบนำทาง ไม่มีสี
navhoverbgcolor สีพื้นหลังของรายการนำทางบนเมาส์ ไม่มีสี
NavhoverTextColor สีข้อความของรายการนำทางบนเมาส์ ไม่มีสี
Navaccentcolor ตัวบ่งชี้รายการที่เลือกปัจจุบัน ไม่มีสี
Navitempacing ควบคุมตัวอย่างการเว้นวรรครายการการนำทาง ค่าเริ่มต้น

ตัวเลือกเค้าโครง UI

คุณสมบัติ คำอธิบาย ค่าเริ่มต้น
เค้าโครง เค้าโครงช่วยในการจัดวางส่วนคำขอ/การตอบกลับ ในเค้าโครงคอลัมน์ส่วนการร้องขอและการตอบกลับจะถูกวางไว้ด้านล่างอีกด้านหนึ่งในเค้าโครงแถวพวกเขาจะถูกวางไว้เคียงข้างกัน แอตทริบิวต์นี้ใช้ได้เฉพาะเมื่อความกว้างของอุปกรณ์มากกว่า 768px และรูปแบบการแสดงผลคือ 'มุมมอง' แถว
renderstyle กำหนดการแสดงผลของ API-DOCS ปัจจุบันมีสามโหมดที่รองรับ
ดู เป็นมิตรสำหรับการสำรวจอย่างรวดเร็ว (ขยาย/ยุบส่วนที่คุณสนใจ)
อ่าน เหมาะสำหรับการอ่าน (เช่นหน้าเว็บต่อเนื่อง)
มุ่งเน้น คล้ายกับการอ่าน แต่มุ่งเน้นไปที่จุดสิ้นสุดเดียวในแต่ละครั้ง (ดีสำหรับสเป็คขนาดใหญ่)
อ่าน เพิ่มเติมสำหรับการอ่าน มุมมอง ที่เป็นมิตรมากขึ้นสำหรับการสำรวจอย่างรวดเร็ว		 ดู
onnavtagclick ใช้กับสไตล์การแสดงที่มุ่งเน้นเท่านั้น มันกำหนดพฤติกรรมของการคลิกบนแท็กในแถบการนำทาง มันสามารถขยายการปิดบังแท็กหรือนำคุณไปที่หน้าคำอธิบายของแท็ก ขยายการปิดบัง
Schemastyle สองวิธีที่แตกต่างกันในการแสดง schemas วัตถุในการตอบสนองและขอร่าง ต้นไม้
schemaexpandlevel Schemas ถูกขยายโดยค่าเริ่มต้นใช้แอตทริบิวต์นี้เพื่อควบคุมจำนวนระดับในสคีมาควรขยาย 999
schemadescriptionexpanded ข้อ จำกัด และคำอธิบายข้อมูลของฟิลด์ในสคีมาถูกยุบเพื่อแสดงเฉพาะบรรทัดแรก ตั้งค่าเป็นจริงหากคุณต้องการให้พวกเขาขยายอย่างเต็มที่ เท็จ
schemahidereadonly ยื่นแบบอ่านอย่างเดียวใน schemas คำขอมักจะซ่อนอยู่เสมอ แต่จะแสดงในการตอบสนอง
หากคุณไม่ต้องการซ่อนฟิลด์แบบอ่านอย่างเดียวหรือซ่อนตามการกระทำคุณสามารถกำหนดค่าการตั้งค่านี้เป็น 'ไม่เคย' หรือการรวมกันของโพสต์ | ใส่ | แพตช์เพื่อระบุตำแหน่งที่จะซ่อน
Schemas ในส่วนการตอบสนองไม่ได้รับผลกระทบจากการตั้งค่านี้		 เสมอ
schemahidewriteonly ข้อ จำกัด และคำอธิบายข้อมูลของฟิลด์ในสคีมาถูกยุบเพื่อแสดงเฉพาะบรรทัดแรก ตั้งค่าเป็นจริงหากคุณต้องการให้พวกเขาขยายอย่างเต็มที่ เสมอ
defaultSchematab schemas จะแสดงในสองแท็บ - โมเดลและตัวอย่าง ตัวเลือกนี้ช่วยให้คุณสามารถเลือกแท็บเริ่มต้นที่คุณต้องการใช้งานได้ แบบอย่าง
คำตอบ ค่าความสูง CSS ที่ถูกต้องเช่น 400px, 50%, 60vh ฯลฯ - ใช้ค่านี้เพื่อควบคุมความสูงของการตอบสนอง textarea "300px"

ตัวเลือกส่วน

คุณสมบัติ คำอธิบาย ค่าเริ่มต้น
การแสดง แสดง/ซ่อนส่วนข้อมูลเอกสาร
ส่วนข้อมูลมีข้อมูลเกี่ยวกับข้อมูลจำเพาะเช่นชื่อและคำอธิบายของข้อมูลจำเพาะเวอร์ชันข้อกำหนดของบริการ ฯลฯ ในสถานการณ์บางอย่างคุณอาจไม่จำเป็นต้องแสดงส่วนนี้เช่นคุณกำลังฝังองค์ประกอบนี้ภายในเอกสารช่วยเหลืออื่น โอกาสที่เอกสารช่วยเหลืออาจมีข้อมูลนี้อยู่แล้วในกรณีนั้นคุณอาจต้องการซ่อนส่วนนี้		 จริง
Infodescriptionheadingsinnavbar รวมส่วนหัวจากข้อมูล -> ส่วนคำอธิบายไปยังแถบการนำทาง (ใช้กับโหมดอ่านเท่านั้น)
จะได้รับส่วนหัวจาก markdown in info - คำอธิบาย (H1 และ H2) ลงในเมนูทางด้านซ้าย (ในโหมดอ่าน) พร้อมกับลิงก์ไปยังพวกเขา ตัวเลือกนี้ช่วยให้ผู้ใช้สามารถเพิ่มรายการแถบการนำทางโดยใช้ markdown		 เท็จ
การแสดงสินค้า แสดง/ซ่อนส่วนประกอบทั้งในเอกสารและเมนู (มีเฉพาะในรูปแบบการแสดงผลที่เน้น)
จะแสดงส่วนส่วนประกอบพร้อมกับ schemas, คำตอบ, ตัวอย่าง, requestbodies, ส่วนหัว, securityschemes, ลิงก์และการโทรกลับจะแสดงในเมนูทางด้านซ้าย (ในโหมดอ่าน)		 เท็จ
ผู้แสดง แสดง/ซ่อนส่วนหัว
หากคุณไม่ต้องการให้ผู้ใช้ของคุณเปิดข้อมูลจำเพาะ API อื่น ๆ นอกเหนือจากข้อมูลปัจจุบันให้ตั้งค่าแอตทริบิวต์นี้เป็นเท็จ		 จริง
ALLEATAUTHENTICATION คุณสมบัติการตรวจสอบสิทธิ์ช่วยให้ผู้ใช้สามารถเลือกหนึ่งในกลไกการตรวจสอบความถูกต้องที่มีอยู่ในสเป็ค มันสามารถเป็น http-basic, http-bearer หรือ api-key หากคุณไม่ต้องการให้ผู้ใช้ของคุณผ่านกระบวนการตรวจสอบสิทธิ์แทนที่จะต้องการให้พวกเขาใช้ API-KEY ที่สร้างไว้ล่วงหน้าคุณอาจซ่อนส่วนการตรวจสอบโดยการตั้งค่าแอตทริบิวต์นี้เป็นเท็จและให้รายละเอียด API-KEY โดยใช้ API-KEY ต่างๆ-???? คุณลักษณะ จริง
อนุญาตให้ pecurlload หากตั้งค่าเป็น 'false' ผู้ใช้จะไม่สามารถโหลด URL ข้อมูลจำเพาะใด ๆ จาก UI เท็จ
อนุญาตให้ pecfileload หากตั้งค่าเป็น 'FALSE' ผู้ใช้จะไม่สามารถโหลดไฟล์ Spec ใด ๆ จากไดรฟ์ท้องถิ่น แอตทริบิวต์นี้ใช้ได้เฉพาะเมื่อความกว้างของอุปกรณ์มีมากกว่า 768px แต่คุณสมบัตินี้ไม่สามารถใช้ได้ เท็จ
อนุญาตให้ค้นหา ให้การกรอง API อย่างรวดเร็ว จริง
อนุญาตให้ ALLEVANCEDSEARCH ให้ฟังก์ชั่นการค้นหาขั้นสูงเพื่อค้นหาผ่าน API-Paths, API-Description, API-parameters และ API-responses จริง
allowtry คุณลักษณะ 'ลอง' ช่วยให้คุณสามารถเรียกใช้ REST ไปยังเซิร์ฟเวอร์ API หากต้องการปิดการใช้งานคุณสมบัตินี้ให้ตั้งค่าเป็นเท็จ จริง
อนุญาตให้มีการเลือก หากตั้งค่าเป็น 'false' ผู้ใช้จะไม่สามารถดูหรือเลือกเซิร์ฟเวอร์ API (รายการเซิร์ฟเวอร์จะถูกซ่อนอยู่อย่างไรก็ตามผู้ใช้จะสามารถดู URL เซิร์ฟเวอร์ใกล้กับปุ่ม 'ลอง' เพื่อทราบล่วงหน้าว่าการลองจะส่งคำขอ) URL ที่ระบุในแอตทริบิวต์ Server-URL จะถูกใช้หากตั้งค่าอื่น ๆ เซิร์ฟเวอร์แรกในไฟล์ข้อกำหนด API จะถูกใช้ จริง
อนุญาตให้ ChemadescriptionExpandToggle อนุญาตหรือซ่อนความสามารถในการขยาย/ยุบคำอธิบายฟิลด์ในสคีมา จริง

ตัวเลือกเซิร์ฟเวอร์ API

คุณสมบัติ คำอธิบาย ค่าเริ่มต้น
เซิร์ฟเวอร์ Spec OpenAPI มีข้อกำหนดสำหรับการจัดหา URL ของเซิร์ฟเวอร์ UI จะแสดงรายการ URL ของเซิร์ฟเวอร์ทั้งหมดที่ให้ไว้ในข้อมูลจำเพาะ จากนั้นผู้ใช้สามารถเลือก URL หนึ่ง URL ที่เขาหรือเธอตั้งใจจะส่งการโทร API ในขณะที่ลองใช้ API อย่างไรก็ตามหากคุณต้องการให้เซิร์ฟเวอร์ API ของคุณเองซึ่งไม่ได้อยู่ในรายการข้อมูลจำเพาะคุณสามารถใช้คุณสมบัตินี้เพื่อให้หนึ่ง มันมีประโยชน์ในกรณีที่มีการแชร์ข้อมูลจำเพาะเดียวกันระหว่างหลาย ๆ สภาพแวดล้อมกล่าวว่า dev และการทดสอบและแต่ละคนมีเซิร์ฟเวอร์ API ของตัวเอง String.empty
defaultApiserver หากคุณมีเซิร์ฟเวอร์ API หลายรายการที่ระบุไว้ในข้อมูลจำเพาะให้ใช้แอตทริบิวต์นี้เพื่อเลือกเซิร์ฟเวอร์ API เริ่มต้นซึ่งการโทร API ทั้งหมดจะไป สามารถเปลี่ยนแปลงได้ในภายหลังจาก UI String.empty
apikeyname ชื่อของคีย์ API ที่จะส่งขณะลองใช้ APIs String.empty
การวางตำแหน่ง กำหนดวิธีที่คุณต้องการส่ง api-key ไม่ได้ตั้งค่า
apikeyvalue มูลค่าของคีย์ API ที่จะส่งขณะลองใช้ API นอกจากนี้ยังสามารถให้/เขียนทับจาก UI String.empty
petchcredentials เปิดใช้งานข้อมูลรับรอง/คุกกี้ในการโทรข้ามโดเมนตามที่กำหนดไว้ในมาตรฐานการดึงข้อมูลในคำขอ CORS ที่เบราว์เซอร์ส่ง ไม่ได้ตั้งค่า

ตัวเลือกสล็อต

คุณสมบัติ คำอธิบาย ค่าเริ่มต้น
โลโก้ แทนที่โลโก้เริ่มต้นของส่วนหัวด้วย URL ที่ระบุ String.empty
การบันทึก ระบุความกว้างของโลโก้ของโลโก้ที่กำหนดเองไม่ได้ใช้กับโลโก้เริ่มต้น 36
Logoheight ระบุความสูงของโลโก้ของโลโก้ที่กำหนดเองไม่ได้ใช้กับโลโก้เริ่มต้น 36
Logopadding ระบุการขยายโลโก้ของโลโก้ที่กำหนดเองไม่สามารถใช้กับโลโก้เริ่มต้นได้ 0
Navlogo เพิ่มโลโก้การนำทางที่ด้านบนของแถบนำทางด้านข้างพร้อม URL ที่ให้ไว้เฉพาะในโหมดอ่าน String.empty
Navlogowidth ระบุความกว้างของโลโก้การนำทางของโลโก้ที่กำหนดเองเฉพาะในโหมดอ่าน 36
Navlogoheight ระบุความสูงของโลโก้การนำทางของโลโก้ที่กำหนดเองเฉพาะในโหมดอ่าน 36
Navlogopadding ระบุช่องว่างของโลโก้การนำทางของโลโก้ที่กำหนดเองเฉพาะในโหมดอ่าน 0
ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด