騰訊云API文檔簡(jiǎn)潔之美，只需三步開啟

API最初出現(xiàn)時(shí)通常被用作操作系統(tǒng)的庫(kù)，而且?guī)缀醵荚诒镜氐南到y(tǒng)中運(yùn)行。到2000年代初，它們已脫離本地運(yùn)行環(huán)境，成為遠(yuǎn)程交互數(shù)據(jù)的重要技術(shù)?，F(xiàn)如今，API不僅僅是一種技術(shù)連接，也成為了一種商業(yè)連接。通過(guò)開放API，個(gè)人或者企業(yè)可以打開自由之門，向客戶、合作伙伴提供數(shù)字化產(chǎn)品和服務(wù)。API網(wǎng)關(guān)作為管理API的平臺(tái)，也在朝著為API開發(fā)者提供更豐富、完整的服務(wù)方向前進(jìn)。近期，騰訊云API網(wǎng)關(guān)在現(xiàn)有API全生命周期管理能力基礎(chǔ)上，聯(lián)合CODING API文檔產(chǎn)品團(tuán)隊(duì)，為開發(fā)者提供了API文檔生成工具，基于這個(gè)工具開發(fā)者可以按需發(fā)布API文檔。

騰訊云API網(wǎng)關(guān)（以下簡(jiǎn)稱API網(wǎng)關(guān)）是騰訊云Severless團(tuán)隊(duì)推出的API托管服務(wù)，能提供API的完整生命周期管理，包括創(chuàng)建、維護(hù)、發(fā)布、運(yùn)行、下線等。您可使用API網(wǎng)關(guān)封裝自身業(yè)務(wù)，將您的數(shù)據(jù)、業(yè)務(wù)邏輯或功能安全可靠的開放出來(lái)，用以實(shí)現(xiàn)自身系統(tǒng)集成、以及與合作伙伴的業(yè)務(wù)連接。

精準(zhǔn)簡(jiǎn)潔的API文檔可以降低API協(xié)作的復(fù)雜度，給予API使用者更直觀的API信息，簡(jiǎn)化并加速API集成過(guò)程。例如在常見的前后端開發(fā)協(xié)作場(chǎng)景中，通過(guò)一份接口文檔，就可以實(shí)現(xiàn)前后端并行開發(fā)：后臺(tái)開發(fā)者把API托管在API網(wǎng)關(guān)上，配好mock server，利用API文檔功能把API信息提供給前端同學(xué)，來(lái)實(shí)現(xiàn)前后端分離。API文檔可以解決的問(wèn)題不僅僅于此：

·如果你把API當(dāng)做接口，那么你需要讓使用方知道該如何對(duì)接這個(gè)系統(tǒng)，那么你的API文檔就是你提供的詳細(xì)說(shuō)明書。

·如果你把API當(dāng)作契約，那么你需要讓合作方詳細(xì)了解你們之間的規(guī)則，你的API文檔就是各方之間的完整協(xié)議。

·如果你把API當(dāng)作商品，那么你需要讓你的客戶知道可以按什么方式下單，你的API文檔就是你提供的精美菜單。

現(xiàn)在，在騰訊云API網(wǎng)關(guān)控制臺(tái)，只用三步就可快速發(fā)布您的API文檔。

三步開啟簡(jiǎn)潔API文檔

步驟1：在您登錄「騰訊云API網(wǎng)關(guān)控制臺(tái)」后，在工具一欄選擇「API文檔」，就可以針對(duì)你現(xiàn)有的API創(chuàng)建對(duì)應(yīng)文檔。

選擇好您要發(fā)布的API，剩下的都交給CODING API文檔與API網(wǎng)關(guān)。

步驟2：喝上幾口熱水的功夫，就可以看到自動(dòng)構(gòu)建完畢的API文檔鏈接，你可以隨時(shí)隨地將這個(gè)鏈接和口令分享給你的協(xié)作者。

步驟3：拿到鏈接與口令后，你的協(xié)作者就可以在瀏覽器中看到清晰、簡(jiǎn)潔、規(guī)范的API文檔。三欄的經(jīng)典文檔格式，同時(shí)展示API列表、API詳情與調(diào)用范例，更符合開發(fā)者閱讀習(xí)慣。適當(dāng)?shù)念伾吡僚c恰到好處的間距用來(lái)展示每個(gè)API的詳細(xì)調(diào)用說(shuō)明：包括URL、Request、Response等等信息。一旦API接口內(nèi)容發(fā)生改變（雖然API不常變），只要在API文檔工具里點(diǎn)擊「更新」，不變的API文檔地址，最新的API文檔內(nèi)容。

好用怎么就不能好看？

對(duì)于開發(fā)者，從一行代碼，到一個(gè)函數(shù)，再到一個(gè)應(yīng)用程序、一個(gè)API文檔或者一篇技術(shù)博客，這些工作成果都是你或者你所在團(tuán)隊(duì)的名片，我們希望你的工作成果不僅高效還體面。CODING開發(fā)團(tuán)隊(duì)深耕API協(xié)作方式多年，帶來(lái)了令人賞心悅目的API文檔，只為帶來(lái)沉浸的閱讀體驗(yàn)。API文檔工具現(xiàn)已在騰訊云API網(wǎng)關(guān)正式上線并免費(fèi)開放，API網(wǎng)關(guān)用戶可以立即擁有全新的API文檔。

關(guān)于CODING

對(duì)于API文檔功能有更加多樣化需求的用戶，可以選擇登錄CODING使用更加全面的API文檔管理功能，包括支持OpenAPI/Postman/Apidoc API描述格式導(dǎo)入文檔、自由選擇開放文檔方式等等，開始有序的API文檔協(xié)作。不僅僅是API文檔，致力于“讓開發(fā)更簡(jiǎn)單”的CODING，提供了從代碼托管、項(xiàng)目協(xié)同、持續(xù)集成、制品庫(kù)、持續(xù)部署、文件管理/Wiki等的一站式研發(fā)協(xié)作工具。