![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/69c87ac632bc47efbb8f767d4a76e0fb~tplv-k3u1fbpfcp-zoom-1.image)
> 🤔️ 那可以在生成的接口文檔在進一步自定義“裝飾”下不?
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/cf320043dfcd46a8ae8c5816ddec303e~tplv-k3u1fbpfcp-zoom-1.image)
可以的,Apifox 目前提供的文檔自定義的區域有
- `頂部導航菜單`
- `頂部導航右側功能區`
- `文檔内容底部Banner區`
可以在釋出文檔欄目下進行定義
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/49e4addefbc2407a8b0bdfb185169e42~tplv-k3u1fbpfcp-zoom-1.image)
後續在官網文檔也有提及,将會有更多開放區域供我們DIY!
不僅如此,你還可以自定義域名。目前通過Apifox釋出的文檔使用 xxx.apifox.cn 格式的URL,但是你可以将你的域名直接指向你釋出的文檔 👇
- 1.在`釋出文檔 > 釋出設定` 面闆中設定自己自定義的域名
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/96491fa7c93d47eab7923002c7beed7f~tplv-k3u1fbpfcp-zoom-1.image)
- 2.添加Apifox的`CNAME`到你域名廠商的配置中心
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/25de8ac05322475aa869d76bd42995e1~tplv-k3u1fbpfcp-zoom-1.image)
最後釋出通過你自定義的接口文檔,也可以申請釋出到上文提到的`API Hub`中
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/68ff6105bdef408ebdc8b86abae94426~tplv-k3u1fbpfcp-zoom-1.image)
完成上述操作,你将會收獲一個好用好看API文檔
- API文檔是支援線上調試的
- 域名是你自定義的
- 文檔自定義區域是你DIY的
分享給朋友倍有面子!
官方位址:[apifox.cn](https://www.apifox.cn/?utm_source=liam)
### 最後
API文檔功能隻是**Apifox**強大功能中冰上一角,還提供了`API調試`、`API Mock`、`API自動化測試`等功能
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/a007d82a9aa248b8b9de108a14ae6747~tplv-k3u1fbpfcp-zoom-1.image)
5分鐘打造好用好看API文檔
🤔️ 你是否遇到過這樣的場景?
- 對接第三方開放平台文檔的時候,左手刷着接口文檔看API,右手操作着接口調試工具 🧱
- 寫完接口想傳遞或提供API文檔給第三方使用,又覺得文檔展示體驗一般?很雞肋?
前言
早期第三方開放平台的開放接口文檔,主要以資訊展示為主,基本資訊包括請求方式、參數說明、傳回結果等等。這裡以企業微信開發者中心文檔為例 👇
而在很長一段時間,為了調試開放接口,我們是不是也是經常習慣左邊對着接口文檔,右邊打開Postman調試。
而在上周微信開放平台上線了調試工具,将文檔與線上調試一體化融合。從某種意義上打破了原有單一的資訊展示為主的局面
而這樣帶來的好處就是通過接口文檔即可一鍵抵達調試工具台
🤔️ 那如果其他的開放平台都支援線上調試,是不是效率就提升了一個level?
通過上文我們看到微信實際上提供了一個調試工具賦能原有的接口文檔
但是其他平台,如果想省時省力也開發一套
具備線上調試的接口文檔體系
那Apifox會是你最滿意的選擇
官網位址:apifox.cn
Apifox在接口文檔中內建了調試功能、代碼線上生成等等 👇
上圖是接口管理Saas服務商Apifox推出的Apihub(開放 API 共享平台)其中企業微信的開放文檔。
通過文檔線上調試,進一步提升開發者對接開放平台API的效率。
該平台目前已經聚合了
大部分主流第三方開放API
換句話說通過Apifox賦能的
開放API文檔
都是具備線上調試、代碼生成 。包括一下特征
支援線上調試:點選請求,實時顯示調試結果,傳回資訊一目了然
自動生成代碼片段:支援自動生成代碼片段,省時省力更高效
🤔️ 那作為個人開放者,是否可以通過Apifox釋出這樣好看好用的API文檔?
可以的,5分鐘教你搞定!
Apifox釋出API文檔
首先我們在Apifox軟體的線上分享Tab中找到
建立分享
按鈕
然後在建立分享的彈窗中選擇分享屬性(文檔語言、通路密碼、環境選擇、分享範圍等等)這裡以寵物商店Demo為例
儲存成功後将滑鼠移動到分享清單中的剛剛建立的分享中,點選界面中出現的打開連結 👇
打開Apifox生成接口文檔呈現如下,同樣也可以支援線上調試!
🤔️ 那可以在生成的接口文檔在進一步自定義“裝飾”下不?
可以的,Apifox 目前提供的文檔自定義的區域有
-
頂部導航菜單
-
頂部導航右側功能區
-
文檔内容底部Banner區
可以在釋出文檔欄目下進行定義
後續在官網文檔也有提及,将會有更多開放區域供我們DIY!
不僅如此,你還可以自定義域名。目前通過Apifox釋出的文檔使用 xxx.apifox.cn 格式的URL,但是你可以将你的域名直接指向你釋出的文檔 👇
- 1.在
面闆中設定自己自定義的域名釋出文檔 > 釋出設定
- 2.添加Apifox的
到你域名廠商的配置中心CNAME
最後釋出通過你自定義的接口文檔,也可以申請釋出到上文提到的
API Hub
中
完成上述操作,你将會收獲一個好用好看API文檔
- API文檔是支援線上調試的
- 域名是你自定義的
- 文檔自定義區域是你DIY的
分享給朋友倍有面子!