接下來,就帶大家一步步實(shí)現(xiàn)這個(gè)效果。

image

創(chuàng)建新的 API 版本

我們首先需要為每種語言創(chuàng)建獨(dú)立的 API 版本。在 Apifox 中,你有兩種選擇:可以基于現(xiàn)有的 API 版本創(chuàng)建副本,也可以從零開始創(chuàng)建新版本。推薦使用第一種方式,因?yàn)檫@樣可以保留原有的接口結(jié)構(gòu)和示例數(shù)據(jù),只需要專注于內(nèi)容翻譯即可。

舉個(gè)例子,如果你要?jiǎng)?chuàng)建英文版文檔,可以這樣操作:

image

其它語言的文檔也可以根據(jù)上面的操作來創(chuàng)建對(duì)應(yīng)的 API 版本。

?? 小貼士

image

編寫對(duì)應(yīng)語言的文檔

有了新的版本后,即可開始編寫或翻譯對(duì)應(yīng)語言的文檔。

image

image

發(fā)布文檔

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

在添加“發(fā)布版本”時(shí),你可以做這些個(gè)性化配置:

image

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

image

image

優(yōu)化配置讓文檔更專業(yè)

image

上面就是一個(gè)簡(jiǎn)略版的多語言 API 文檔實(shí)現(xiàn)過程,除此之外,你還可以通過一些配置選項(xiàng)對(duì)其進(jìn)行調(diào)整,讓你的 API 文檔更加專業(yè)和易用,比如:

image

界面語言與品牌定制

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

image

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

image

image

文檔布局與導(dǎo)航優(yōu)化

在 “個(gè)性化設(shè)置 -> 布局導(dǎo)航設(shè)置” 中,你可以自定義頂部導(dǎo)航、頂部通知以及底部 Banner 區(qū)。

image

image

自定義域名

可以給你的文檔配置專屬域名。Apifox 支持通過 CNAME 方式或自有服務(wù)器中轉(zhuǎn)來實(shí)現(xiàn)域名綁定,配置過程也很簡(jiǎn)單:

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

image

image

Algolia DocSearch 集成

為了讓文檔的搜索更加友好,你還可以申請(qǐng)一個(gè)免費(fèi)的 Algolia DocSearch 計(jì)劃,將 Algolia 的文檔搜索服務(wù)集成到 Apifox 構(gòu)建的 API 文檔中,操作過程也很簡(jiǎn)單,申請(qǐng)成功之后,Algolia 會(huì)給你發(fā)送郵件,只要將相關(guān)的配置項(xiàng)填寫到 Apifox 中即可,詳情可以查看與 Algolia DocSearch 集成的幫助文檔模塊。

image

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

image

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

image

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

image

原文轉(zhuǎn)載自:https://mp.weixin.qq.com/s/ssYx5zv0Zz8uZK1QAdKQOQ

上一篇:

Claude API 能使用 OpenAI 接口協(xié)議嗎?

下一篇:

大模型 API 異步調(diào)用優(yōu)化:高效并發(fā)與令牌池設(shè)計(jì)實(shí)踐
#你可能也喜歡這些API文章!

我們有何不同?

API服務(wù)商零注冊(cè)

多API并行試用

數(shù)據(jù)驅(qū)動(dòng)選型,提升決策效率

查看全部API→
??

熱門場(chǎng)景實(shí)測(cè),選對(duì)API

#AI文本生成大模型API

對(duì)比大模型API的內(nèi)容創(chuàng)意新穎性、情感共鳴力、商業(yè)轉(zhuǎn)化潛力

25個(gè)渠道
一鍵對(duì)比試用API 限時(shí)免費(fèi)

#AI深度推理大模型API

對(duì)比大模型API的邏輯推理準(zhǔn)確性、分析深度、可視化建議合理性

10個(gè)渠道
一鍵對(duì)比試用API 限時(shí)免費(fèi)