接下來,就帶大家一步步實現這個效果。

image

創建新的 API 版本

我們首先需要為每種語言創建獨立的 API 版本。在 Apifox 中,你有兩種選擇:可以基于現有的 API 版本創建副本,也可以從零開始創建新版本。推薦使用第一種方式,因為這樣可以保留原有的接口結構和示例數據,只需要專注于內容翻譯即可。

舉個例子,如果你要創建英文版文檔,可以這樣操作:

image

其它語言的文檔也可以根據上面的操作來創建對應的 API 版本。

?? 小貼士

image

編寫對應語言的文檔

有了新的版本后,即可開始編寫或翻譯對應語言的文檔。

image

image

發布文檔

文檔編寫或翻譯完成后,就可以將其發布了。在 “分享文檔” 模塊中,你可以發布一個文檔站。然后在已發布的文檔站中,繼續添加其它語言的“發布版本”。

在添加“發布版本”時,你可以做這些個性化配置:

image

配置完成并保存后,就可以在線上文檔查看不同語言版本的文檔了。

image

image

優化配置讓文檔更專業

image

上面就是一個簡略版的多語言 API 文檔實現過程,除此之外,你還可以通過一些配置選項對其進行調整,讓你的 API 文檔更加專業和易用,比如:

image

界面語言與品牌定制

在 “個性化設置 -> 外觀設置” 中,可將項目的界面語言選擇一個默認語言(比如英語),以保持一致性體驗。你還可以上傳 Logo、自定義主題色調、設置 favicon、亮暗模式等等。

image

對于不需要的功能模塊,你還可以將其隱藏。

image

image

文檔布局與導航優化

在 “個性化設置 -> 布局導航設置” 中,你可以自定義頂部導航、頂部通知以及底部 Banner 區。

image

image

自定義域名

可以給你的文檔配置專屬域名。Apifox 支持通過 CNAME 方式或自有服務器中轉來實現域名綁定,配置過程也很簡單:

同時,還支持 HTTPS 訪問,SSL 證書可以選擇自動生成或使用自有證書。配置完成后,你就可以通過自己的域名來訪問 API 文檔了。詳情可以查看自定義域名的幫助文檔。

image

image

Algolia DocSearch 集成

為了讓文檔的搜索更加友好,你還可以申請一個免費的 Algolia DocSearch 計劃,將 Algolia 的文檔搜索服務集成到 Apifox 構建的 API 文檔中,操作過程也很簡單,申請成功之后,Algolia 會給你發送郵件,只要將相關的配置項填寫到 Apifox 中即可,詳情可以查看與 Algolia DocSearch 集成的幫助文檔模塊。

image

通過這些細節配置,我們就能打造出這樣一個專業、美觀、交互友好的多語言 API 文檔。來看看最終效果:

image

?? 本文的多語言文檔可在該地址預覽參考:https://openaidocs.apifox.cn/

image

以上就是在 Apifox 中實現多語言 API 文檔的操作教程。通過版本管理這個核心功能,搭配個性化的配置選項,我們就能輕松構建一個專業的多語言文檔站點。如果你也有多語言文檔的需求,趕快動手試試吧!想要了解更多詳細信息,請參考 Apifox 的幫助文檔,并通過實際使用來體驗 Apifox 帶來的便利與高效。如果你有什么酷炫的想法或者實踐,歡迎在評論區分享,也歡迎發送郵件至 link@apifox.com 投稿,有精美周邊掉落哦!無論是個人使用小技巧,還是解決難題的思路想法,統統都可以!

image

原文轉載自:https://mp.weixin.qq.com/s/ssYx5zv0Zz8uZK1QAdKQOQ

上一篇:

Claude API 能使用 OpenAI 接口協議嗎?

下一篇:

API 設計原理:從理論到實踐
#你可能也喜歡這些API文章!

我們有何不同?

API服務商零注冊

多API并行試用

數據驅動選型,提升決策效率

查看全部API→
??

熱門場景實測,選對API

#AI文本生成大模型API

對比大模型API的內容創意新穎性、情感共鳴力、商業轉化潛力

25個渠道
一鍵對比試用API 限時免費

#AI深度推理大模型API

對比大模型API的邏輯推理準確性、分析深度、可視化建議合理性

10個渠道
一鍵對比試用API 限時免費