AspNetCore.RapiDoc
1.0.0
| 재산 | 설명 | 기본 |
|---|---|---|
| ROUTEPREFIX | Rapidoc에 액세스하기위한 경로 접두사 | "Rapidoc" |
| Specurl | 볼 수있는 OpenApi 사양의 URL | 문자열 |
| HeadingText | 왼쪽 상단에 제목 텍스트 | "Rapidoc" |
| 정렬 | 허용 : True | 거짓 알파벳 순서로 태그를 나열하려면 태그가 사양의 태그 섹션에 지정된 방법에 따라 순서가 주문됩니다. | 거짓 |
| SortendPointsby | 허용 : 경로 | 방법 | 요약 경로, 메소드 또는 요약별로 각 태그 내의 엔드 포인트 정렬 | 예 | 길 |
| gotopath | 사양이로드 된 후에 가고 싶은 문서의 초기 위치 (메소드 및 경로로 식별). 예를 들어/사용자/로그인을 스크롤하려면 new PathInfo(SubmitMethod.Get,"/user/login") | 널 |
| FillRequestFieldswithexample | 허용 : True | 거짓 요청 필드는 예제 값으로 채워집니다 (사양에 제공된 경우) | 진실 |
| 재산 | 설명 | 기본 |
|---|---|---|
| 주제 | 기본 테마는 다양한 UI 구성 요소의 색상을 계산하는 데 사용됩니다. '테마', 'bg-color'및 'text-color'는 사용자 정의 테마를 생성하기위한 기본 속성입니다. | 어두운 |
| bgcolor | 주요 배경을위한 색상 | 다크 테마 #333 가벼운 테마 #fff |
| 텍스트 컬러 | 텍스트의 색상 | 다크 테마 #BBB 라이트 테마 #444 |
| 헤드러 컬러 | 헤더의 배경을위한 색상 | #444444 |
| 1 차 콜러 | 버튼, 탭과 같은 다양한 컨트롤의 색상 | #ff791a |
| 로드 폰트 | Rapidoc은 CDN에서 글꼴을로드하려고 시도합니다. | 진실 |
| 정기적 인 | 글꼴 이름은 일반 텍스트에 사용됩니다 | "Open Sans", Avenir, "Segoe Ui", Arial, Sans-Serif |
| 모노 폰트 | 글꼴 이름은 단일 간격 텍스트에 사용됩니다 | 모나코, '안일 모노 (Andale Mono)', '로봇 모노 (Roboto Mono)', 'Consolas'Monospace |
| 글꼴 크기 | 전체 문서의 상대 글꼴 크기를 설정합니다 | 기본 |
| 재산 | 설명 | 기본 |
|---|---|---|
| 사용 Pathinnavbar | 요약/설명 대신 내비게이션 바에 API 경로를 표시하도록 TRUE를 설정 | 예 | 거짓 |
| NAVBGCOLOR | 네비게이션 바의 배경색 예제 | |
| navbgimage | 내비게이션 바의 배경 예제 URL | 문자열 |
| navbgimagesize | 네비게이션 바의 배경 이미지 크기 (CSS 배경 크기 속성과 동일) | 자동 |
| NAVBGIMAGEREPEAT | 네비게이션 바의 배경 이미지 반복 (CSS 배경 반복 속성과 동일) | Norepeat |
| NavTextColor | 네비게이션 바의 텍스트 색상 | 색상 없음 |
| Navhoverbgcolor | 마우스 오버에서 내비게이션 항목의 배경색 | 색상 없음 |
| NavhoverTextColor | 마우스 오버에서 내비게이션 항목의 텍스트 색상 | 색상 없음 |
| NavaccentColor | 현재 선택된 항목 표시기 | 색상 없음 |
| navitemspacing | 내비게이션 항목 간격 예제를 제어합니다 | 기본 |
| 재산 | 설명 | 기본 |
|---|---|---|
| 공들여 나열한 것 | 레이아웃은 요청/응답 섹션의 배치에 도움이됩니다. 열 레이아웃에서 요청 및 응답 섹션은 다른 하나 아래에 배치되며 행 레이아웃에는 나란히 배치됩니다. 이 속성은 장치 너비가 768px 이상이고 렌더 스타일이 '보기'인 경우에만 적용됩니다. | 열 |
| 렌즈 타일 | API-DOC의 표시를 결정합니다. 현재 3 가지 모드가 지원됩니다 빠른 탐색을 위해 친절한 보기 (관심있는 부분을 확장/붕괴) 읽기에 적합한 읽기 (연속 웹 페이지와 같은) 읽기와 비슷 하지만 한 번에 단일 엔드 포인트에 중점을 둡니다 (큰 사양에 적합) 읽기에 더 적합한 읽기를 읽으 십시오 . | 보다 |
| onnavtagclick | 집중 렌더 스타일에만 적용됩니다. 탐색 표시 줄에서 태그를 클릭하는 동작을 결정합니다. 태그를 확장하거나 태그의 설명 페이지로 이동할 수 있습니다. | ExpandCollapse |
| 스키마 스타일 | 응답에 객체-스케인을 표시하고 요청 본문을 표시하는 두 가지 다른 방법 | 나무 |
| SchemaExpandlevel | 스키마는 기본적으로 확장됩니다.이 속성을 사용하여 스키마의 몇 레벨을 확장해야합니다. | 999 |
| schemadescriptionexpanded | 스키마의 필드의 제약 및 설명 정보는 첫 번째 줄만 표시하도록 무너집니다. 완전히 확장하려면 true로 설정하십시오. | 거짓 |
| Schemahidereadonly | 요청 스키마의 읽기 전용 제출은 항상 숨겨져 있지만 응답으로 표시됩니다. 읽기 전용 필드를 숨기거나 작업을 기반으로 숨기고 싶지 않다면이 설정을 'Never'또는 게시물의 조합으로 구성 할 수 있습니다 | put | 숨겨 둘 위치를 나타내는 패치 응답 섹션의 스키마는이 설정의 영향을받지 않습니다. | 언제나 |
| Schemahidewriteonly | 스키마의 필드의 제약 및 설명 정보는 첫 번째 줄만 표시하도록 무너집니다. 완전히 확장하려면 true로 설정하십시오. | 언제나 |
| defaultschematab | 스키마는 모델과 예제의 두 탭으로 표시됩니다. 이 옵션은 활성화하려는 기본 탭을 선택할 수 있습니다. | 모델 |
| 응답 | 400px, 50%, 60VH 등과 같은 유효한 CSS 높이 값 -이 값을 사용하여 응답 높이를 제어하십시오. | "300px" |
| 재산 | 설명 | 기본 |
|---|---|---|
| showinfo | 문서 정보 섹션을 표시/숨기십시오 정보 섹션에는 사양의 제목 및 사양, 버전, 서비스 약관 등과 같은 사양에 대한 정보가 포함되어 있습니다. 특정 상황에서는이 섹션을 표시 할 필요가 없습니다. 예를 들어 다른 도움말 문서 에이 요소를 포함시키고 있습니다. Doc은 이미이 정보를 가지고있을 수 있습니다.이 경우이 섹션을 숨길 수 있습니다. | 진실 |
| infodeScriptionHeadingSinnavbar | Info-> 설명 섹션에서 내비게이션 표시 줄까지 헤더 포함 (읽기 모드에만 적용됨) Info -Description (H1 및 H2)의 Markdown에서 링크와 함께 왼쪽 메뉴 (읽기 모드)로 헤더를 가져옵니다. 이 옵션은 사용자가 Markdown을 사용하여 내비게이션 막대 항목을 추가 할 수 있습니다. | 거짓 |
| Showcomponents | 문서와 메뉴에서 구성 요소 섹션 표시/숨기기 (포커스 렌더 스타일로만 제공됨) 구성 요소 섹션과 스키마, 응답, 예제, 요청 보디, 헤더, 보안 검사, 링크 및 콜백과 함께 왼쪽 메뉴 (읽기 모드)에 표시됩니다. | 거짓 |
| 쇼 헤더 | 헤더를 표시/숨기십시오. 사용자가 현재 API 사양을 열지 않으려면 현재 API 사양을 여는 경우이 속성을 False로 설정하십시오. | 진실 |
| 허용 | 인증 기능을 사용하면 사용자가 사양에서 사용 가능한 인증 메커니즘 중 하나를 선택할 수 있습니다. HTTP-Basic, HTTP-Bearer 또는 API-Key 일 수 있습니다. 사용자가 인증 프로세스를 거치지 않으려면 대신 사전 생성 된 API-Key를 사용하기를 원한다면이 속성을 False로 설정하여 API-KEY를 사용하여 API-Key 세부 정보를 제공하여 인증 섹션을 숨길 수 있습니다. ???? 속성 | 진실 |
| 허용 pecurlload | 'false'로 설정된 경우 사용자는 UI에서 사양 URL을로드 할 수 없습니다. | 거짓 |
| fecfileload 허용 | 'false'로 설정된 경우 사용자는 로컬 드라이브에서 사양 파일을로드 할 수 없습니다. 이 속성은 장치 폭이 768px를 초과 할 때만 적용 가능합니다. 그렇지 않으면이 기능을 사용할 수 없습니다. | 거짓 |
| 허용 | API의 빠른 필터링을 제공합니다 | 진실 |
| allowAdvancedSearch | API-Paths, API-Description, API-Parameters 및 API- 응답을 통해 검색하기 위해 고급 검색 기능을 제공합니다. | 진실 |
| 허용 | 'Try'기능을 사용하면 API 서버로 휴식을 취할 수 있습니다. 이 기능을 비활성화하려면 False로 설정하십시오. | 진실 |
| 허용서 선출 | 'false'로 설정되면 사용자는 API 서버를 보거나 선택할 수 없습니다 (서버 목록은 숨겨져 있지만 사용자는 'Try'버튼 근처의 서버 URL을 볼 수있어 시도가 요청을 보낼 위치를 미리 알 수 있습니다). Server-ORL 속성에 지정된 URL이 설정된 경우 사용됩니다. 그렇지 않으면 API 사양 파일의 첫 번째 서버가 사용됩니다. | 진실 |
| alliseChemadescriptionExpandToggle입니다 | 스키마의 필드 설명을 확장/붕괴 할 수있는 기능을 허용하거나 숨기십시오. | 진실 |
| 재산 | 설명 | 기본 |
|---|---|---|
| ServerUrl | OpenApi Spec에는 서버 URL을 제공하기위한 조항이 있습니다. UI는 사양에 제공된 모든 서버 URL을 나열합니다. 그런 다음 사용자는 API를 시도하는 동안 API 전화를 보내려는 하나의 URL을 선택할 수 있습니다. 그러나 사양에 나열되지 않은 API 서버를 제공하려면이 속성을 사용하여 제공 할 수 있습니다. 여러 환경 사이에 동일한 사양이 공유되는 경우 Dev와 Test와 각각 자체 API 서버가 있습니다. | 문자열 |
| DefaultApiserVer | 사양에 여러 API 서버가 나열된 경우이 속성을 사용하여 모든 API 호출이 Goto에서 기본 API 서버를 선택하십시오. 이것은 나중에 UI에서 변경할 수 있습니다 | 문자열 |
| Apikeyname | API를 시도하는 동안 보내질 API 키의 이름 | 문자열 |
| apikeylocation | API-Key를 보내는 방법을 결정합니다 | 설정되지 않았습니다 |
| apikeyvalue | API를 시도하는 동안 보내질 API 키의 값. 이것은 UI에서 제공/덮어 쓸 수도 있습니다 | 문자열 |
| 메시 멘티블을 가져옵니다 | 브라우저가 전송하는 CORS 요청에서 페치 표준에 정의 된대로 크로스 도메인 호출에서 자격 증명/쿠키를 전달할 수 있습니다. | 설정되지 않았습니다 |
| 재산 | 설명 | 기본 |
|---|---|---|
| 심벌 마크 | 헤더의 기본 로고를 지정된 URL로 대체합니다. | 문자열 |
| logowidth | 사용자 정의 로고의 로고 너비를 지정하고 기본 로고에 적용되지 않습니다. | 36 |
| 로고 하이트 | 사용자 정의 로고의 로고 높이를 지정하고 기본 로고에 적용되지 않습니다. | 36 |
| 로지 패딩 | 사용자 정의 로고의 로고 패딩을 지정하여 기본 로고에 적용되지 않습니다. | 0 |
| Navlogo | 제공된 URL과 함께 측면 탐색 표시 줄 위에 내비게이션 로고가 추가되며 읽기 모드에서만 사용할 수 있습니다. | 문자열 |
| navlogowidth | 사용자 정의 로고의 내비게이션 로고 너비를 지정하고 읽기 모드에서만 사용할 수 있습니다. | 36 |
| NavlogoHeight | Read-Mode에서만 사용할 수있는 사용자 정의 로고의 내비게이션 로고 높이를 지정합니다. | 36 |
| navlogopadding | 사용자 정의 로고의 내비게이션 로고 패드를 지정하고 읽기 모드에서만 사용할 수 있습니다. | 0 |
