微信截圖_17412392891913.png)
在 Golang 中實現(xiàn) JWT 令牌認證
接下來,就帶大家一步步實現(xiàn)這個效果。
我們首先需要為每種語言創(chuàng)建獨立的 API 版本。在 Apifox 中,你有兩種選擇:可以基于現(xiàn)有的 API 版本創(chuàng)建副本,也可以從零開始創(chuàng)建新版本。推薦使用第一種方式,因為這樣可以保留原有的接口結(jié)構(gòu)和示例數(shù)據(jù),只需要專注于內(nèi)容翻譯即可。
舉個例子,如果你要創(chuàng)建英文版文檔,可以這樣操作:
其它語言的文檔也可以根據(jù)上面的操作來創(chuàng)建對應的 API 版本。
?? 小貼士
有了新的版本后,即可開始編寫或翻譯對應語言的文檔。
文檔編寫或翻譯完成后,就可以將其發(fā)布了。在 “分享文檔” 模塊中,你可以發(fā)布一個文檔站。然后在已發(fā)布的文檔站中,繼續(xù)添加其它語言的“發(fā)布版本”。
在添加“發(fā)布版本”時,你可以做這些個性化配置:
配置完成并保存后,就可以在線上文檔查看不同語言版本的文檔了。
上面就是一個簡略版的多語言 API 文檔實現(xiàn)過程,除此之外,你還可以通過一些配置選項對其進行調(diào)整,讓你的 API 文檔更加專業(yè)和易用,比如:
在 “個性化設置 -> 外觀設置” 中,可將項目的界面語言選擇一個默認語言(比如英語),以保持一致性體驗。你還可以上傳 Logo、自定義主題色調(diào)、設置 favicon、亮暗模式等等。
對于不需要的功能模塊,你還可以將其隱藏。
在 “個性化設置 -> 布局導航設置” 中,你可以自定義頂部導航、頂部通知以及底部 Banner 區(qū)。
可以給你的文檔配置專屬域名。Apifox 支持通過 CNAME 方式或自有服務器中轉(zhuǎn)來實現(xiàn)域名綁定,配置過程也很簡單:
同時,還支持 HTTPS 訪問,SSL 證書可以選擇自動生成或使用自有證書。配置完成后,你就可以通過自己的域名來訪問 API 文檔了。詳情可以查看自定義域名的幫助文檔。
為了讓文檔的搜索更加友好,你還可以申請一個免費的 Algolia DocSearch 計劃,將 Algolia 的文檔搜索服務集成到 Apifox 構(gòu)建的 API 文檔中,操作過程也很簡單,申請成功之后,Algolia 會給你發(fā)送郵件,只要將相關的配置項填寫到 Apifox 中即可,詳情可以查看與 Algolia DocSearch 集成的幫助文檔模塊。
通過這些細節(jié)配置,我們就能打造出這樣一個專業(yè)、美觀、交互友好的多語言 API 文檔。來看看最終效果:
?? 本文的多語言文檔可在該地址預覽參考:https://openaidocs.apifox.cn/
以上就是在 Apifox 中實現(xiàn)多語言 API 文檔的操作教程。通過版本管理這個核心功能,搭配個性化的配置選項,我們就能輕松構(gòu)建一個專業(yè)的多語言文檔站點。如果你也有多語言文檔的需求,趕快動手試試吧!想要了解更多詳細信息,請參考 Apifox 的幫助文檔,并通過實際使用來體驗 Apifox 帶來的便利與高效。如果你有什么酷炫的想法或者實踐,歡迎在評論區(qū)分享,也歡迎發(fā)送郵件至 link@apifox.com 投稿,有精美周邊掉落哦!無論是個人使用小技巧,還是解決難題的思路想法,統(tǒng)統(tǒng)都可以!
原文轉(zhuǎn)載自:https://mp.weixin.qq.com/s/ssYx5zv0Zz8uZK1QAdKQOQ