api html

API HTML

將任何 API 規格轉換為出色的 HTML 文件網站

螢幕截圖

使用線上工具

API HTML

使用命令列介面

安裝

npm i api-html -g

用法

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

示範

上面的指令會將給定的url轉換為目前目錄中名為dist目錄的靜態網站。

還可以傳遞file而不是url 。

參數

參數	短的	必需的	預設值	細節
--file	-f	required	無效的	本機原始檔的路徑，同時需要--file或--url on。
--url	-u	required	無效的	線上原始檔的 URL，同時需要--file或--url on。
--type	-t	選修的	swagger	API 規範的編碼類型，例如swagger 、 openapi 、 api_blueprint 、 io_docs 、 google 、 raml或wadl
--version	-v	選修的	2	OpenAPI ( swagger ) 的版本， swagger的值為 1、2 或 3。
--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	」	代表頁面的元關鍵字，每個關鍵字之間以逗號分隔。元關鍵字對頁面搜尋引擎優化很有幫助。
pageDescription	」	表示頁面的元描述
apiVersions	」	API 版本，以以下格式輸入： （名稱）[網址] （名稱）[網址] …… 經驗： (V1)[https://zamacall.io/docs/v1/] (V2)[https://zamacall.io/docs/v2/]
headerMenuItems	」	標題選單項，按以下格式輸入： （名稱）[網址] （名稱）[網址] …… 經驗： （主網站）[https://zamacall.io] (聯絡我們)[https://zamacall.io/contact/]

例子

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

變更日誌

• 新增了新的緊湊 UI 主題；漂亮、乾淨、更快、輕量。
• 新增了對IO Docs原始檔的支持
• 新增了對WADL檔的支持
• 新增了對RAML來源檔案的支持
• 新增了對Google API Descory來源檔案的支持
• 新增了對API Blueprint來源檔案的支持
• 新增了對YAML來源檔案的支持
• 新增了對OpenAPI (swagger) 版本 1、2 和 3 的支援。
• 新增了搜尋功能
• 新增了對嘗試 api 請求的支持
• 新增了對以下語言的程式碼產生的支援： cURL 、 Node 、 Python和JavaScript
• 新增線上工具，可透過線上網站預覽和下載
• 在身份驗證部分添加了自動描述，將替換空描述。
• 新增了對行動裝置等小螢幕的支持

報告問題或請求功能

Github 問題

聯絡我們

[email protected]