完成API開發與設計后,您可以在控制臺一鍵生成SDK及其使用文檔,簡化了API的使用和集成,無論是內部的前后端聯合開發,還是對外提供的API服務,都無需編寫任何額外的代碼來調用API。
前提條件
已完成API創建并添加接口。具體操作,請參見創建REST API并添加接口。
操作步驟
登錄云原生API網關控制臺。
在頂部菜單欄選擇地域,在左側導航欄,單擊API管理。
在API列表中,選擇目標API,選擇頁面右上角
。在SDK&文檔生成對話框中,選擇相關參數,然后單擊生成并下載。
配置項
說明
API版本
選擇要生成SDK與文檔的API版本。
說明若創建API時未啟用版本管理,則無該選項。
SDK語言
目前支持的SDK語言:Java、Golang、Python、Node.js、TypeScript、Swift。
等待生成SDK及相關文檔后,瀏覽器將自動下載SDK及相關文檔的壓縮包至您的本地計算機,您可以到瀏覽器默認下載路徑中進行查看。
說明解壓完成后,您可以參考
README.md
文檔作為SDK的使用指南,該文檔包含了使用SDK所需的基本信息。
文檔內容是否對您有幫助?