api html

API HTML

모든 API 사양을 멋진 HTML 문서 웹사이트로 변환하세요

스크린샷

온라인 도구 사용

API HTML

CLI 사용

설치

npm i api-html -g

용법

api-html --url https://petstore.swagger.io/v2/swagger.json

데모

위 명령은 주어진 url dist 디렉토리 이름을 가진 현재 디렉토리의 정적 웹 사이트로 변환합니다.

url 대신 file 전달할 수도 있습니다.

매개변수

파람	짧은	필수의	기본값	세부
--file	-f	required	null	로컬 소스 파일에 대한 경로 --file 또는 --url on이 동시에 필요합니다.
--url	-u	required	null	온라인 소스 파일에 대한 URL, --file 또는 --url on이 동시에 필요합니다.
--type	-t	선택 과목	swagger	swagger , openapi , api_blueprint , io_docs , google , raml 또는 wadl 과 같은 API 사양의 인코딩된 유형
--version	-v	선택 과목	2	OpenAPI 버전( swagger ), 가능한 값은 1, 2 또는 3입니다. swagger 에만 적용 가능
--yaml	-y	선택 과목	0	소스 파일 유형이 yaml 인 경우 값은 1 이어야 하며 swagger 에만 적용 가능합니다.
--option	-o	선택 과목	./options.json	옵션 파일 경로, 아래 세부정보 참조

예

  api-html --yaml 1 --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/yaml/api-with-examples.yaml
  # A Swagger (OpenAPI) version 2 source file with yaml type

  api-html --version 3 --url https://api.gettyimages.com/swagger/v3/swagger.json
  # A Swagger (OpenAPI) version 3 source file with json type

  api-html --version 3 --yaml 1 --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml
  # A Swagger (OpenAPI) version 3 source file with yaml type

  api-html --type api_blueprint --url https://raw.githubusercontent.com/apiaryio/api-blueprint/master/examples/Polls%20API.md
  # An API Blueprint source file

  api-html --type google --url https://www.googleapis.com/discovery/v1/apis/translate/v2/rest
  # A Google API descory source file

  api-html --type raml --url https://raw.githubusercontent.com/raml-apis/XKCD/master/api.raml
  # A RAML source file

  api-html --type io_docs --url https://raw.githubusercontent.com/lucybot/api-spec-converter/master/test/input/io_docs/foursquare.json
  # An IO Docs source file

옵션(options.json)

옵션은 json 파일에 있어야 합니다. --option 매개변수를 전달하지 않으면 options.json 이름으로 현재 디렉터리를 확인합니다.

이름	기본값	설명
theme	compact	UI 테마를 설정합니다. 값은 "compact" 및 "basic"입니다.
baseColor	#6e9a04	테마의 기본 색상 설정
textColor	#FFF	테마의 텍스트 색상을 설정하세요
logo	'스웨거 로고'	로고를 로컬 파일에 지정
logoUrl	''	로고를 URL에 지정하세요.
isCoding	true	요청의 코딩 섹션 표시 또는 숨기기
isSearch	true	검색 기능 표시 또는 숨기기
isTryRequest	true	요청에 "시도" 버튼 표시 또는 숨기기
isBackToTopButton	true	BackToTop 버튼 숨기기 또는 표시
isCreditLink	true	탐색 모음 아래에 Credit 링크를 숨기거나 표시합니다.
pageTitle	swagger.json 파일의 title	브라우저 제목 표시줄에 표시되는 페이지 제목을 설정합니다.
customHeadScript	''	head 태그에 사용자 정의 스크립트 추가
customFootScript	''	foot 태그에 사용자 정의 스크립트 추가
pageTags	''	페이지의 메타 키워드를 나타내며, 각 키워드는 쉼표로 구분되어야 합니다. 메타 키워드는 페이지 SEO에 도움이 됩니다.
pageDescription	''	페이지의 메타 설명을 나타냅니다.
apiVersions	''	API 버전은 다음 형식으로 입력합니다. (이름)[URL] (이름)[URL] ... 경험치: (V1)[https://zamacall.io/docs/v1/] (V2)[https://zamacall.io/docs/v2/]
headerMenuItems	''	헤더 메뉴 항목은 다음 형식으로 입력합니다. (이름)[URL] (이름)[URL] ... 경험치: (메인사이트)[https://zamacall.io] (문의)[https://zamacall.io/contact/]

예

 {
  "logo": "logo.svg",
  "baseColor": "blue"
} 

변경 로그

• 새로운 Compact UI 테마를 추가했습니다. 좋고, 깨끗하고, 빠르고, 가볍습니다.
• IO Docs 소스 파일에 대한 지원이 추가되었습니다.
• WADL 소스 파일에 대한 지원이 추가되었습니다.
• RAML 소스 파일에 대한 지원이 추가되었습니다.
• Google API Descory 소스 파일에 대한 지원이 추가되었습니다.
• API Blueprint 소스 파일에 대한 지원이 추가되었습니다.
• YAML 소스 파일에 대한 지원이 추가되었습니다.
• OpenAPI (swagger) 버전 1, 2, 3에 대한 지원이 추가되었습니다.
• 검색 기능이 추가되었습니다
• API 요청 시도에 대한 지원이 추가되었습니다.
• cURL , Node , Python 및 JavaScript 와 같은 언어에 대한 코드 생성 지원이 추가되었습니다.
• 온라인 웹사이트를 통해 미리 보고 다운로드할 수 있는 온라인 도구가 추가되었습니다.
• 인증 섹션에 자동 설명이 추가되어 빈 설명이 대체됩니다.
• 모바일 장치와 같은 작은 화면에 대한 지원 추가

문제 보고 또는 기능 요청

Github 문제

문의하기

[email protected]