在 JetBrains IDEs 中使用 Alibaba Cloud Developer Toolkit 插件
本文為您介紹在 JetBrains IDEs 中 Alibaba Cloud Developer Toolkit 插件的安裝和使用。
安裝插件
前提條件
安裝 JetBrains 系列 IDE:IntelliJ IDEA、PyCharm、GoLand等。
版本要求:2022.2+以上版本。
本文以 Windows 的 IntelliJ IDEA 為例,為您介紹插件的兩種安裝方式:
方式一:通過插件市場下載安裝
在IntelliJ IDEA頂部菜單欄右側(cè),選擇
,或通過頂部菜單欄左側(cè),選擇 。在插件頁面,單擊Marketplace。
搜索 Alibaba Cloud Developer Toolkit ,單擊安裝。
單擊應(yīng)用,然后單擊確定。
方式二:通過瀏覽器下載安裝包
通過瀏覽器訪問官方JetBrains Marketplace,下載插件壓縮包到本地。
在IntelliJ IDEA頂部菜單欄右側(cè),選擇
,或通過頂部菜單欄左側(cè),選擇 。在插件頁面,選擇
,選中下載的壓縮包(無需解壓),完成安裝。
驗(yàn)證結(jié)果
安裝完成后,您可以在 IntelliJ IDEA 左側(cè)菜單欄中看到 Toolkit 插件的快捷入口,即安裝成功。
用戶身份與憑證配置
正確的身份憑證配置是調(diào)用 API 的前提。目前該插件僅支持配置 AccessKey(簡稱AK)憑證。您可以通過以下兩種方式進(jìn)行配置。
方式一
單擊左上角的New Profile或圖標(biāo)。
填寫配置信息,包括Profile Name、RegionId及Access Key ID 和 Secret Access Key信息。關(guān)于AccessKey的詳細(xì)信息,請參見查看RAM用戶的AccessKey信息。
重要由于阿里云賬號(主賬號)擁有資源的所有權(quán)限,其AK一旦泄露風(fēng)險(xiǎn)巨大,強(qiáng)烈不建議使用阿里云主賬號AK。
單擊添加配置。
在右下角會(huì)彈出添加 Profile 成功的對話框,然后通過單擊左側(cè)窗口中的下拉框,可以查看到已配置成功的用戶,即添加成功。
單擊Profile名稱,即可切換身份。
方式二
如果您已安裝并使用阿里云CLI,該插件會(huì)自動(dòng)復(fù)用其配置。關(guān)于如何通過CLI配置身份與憑證的詳情,請參見阿里云 CLI 配置憑證。
您可以通過單擊左側(cè)窗口中的下拉框或右下角狀態(tài)欄,來切換或查看已有用戶與憑證。
在左側(cè)窗口的下拉框中,單擊Profile名稱,即可切換身份。
功能介紹
Alibaba Cloud Developer Toolkit 插件支持在 JetBrains IDEs 中快速查閱阿里云產(chǎn)品的 API,并提供 API 調(diào)試、生成 SDK、插入 SDK 示例代碼等功能,讓您更便捷地在 IDE 環(huán)境中訪問阿里云服務(wù)。
云產(chǎn)品和 API 搜索
在插件的左側(cè)導(dǎo)航欄中,提供了一個(gè)云產(chǎn)品的樹狀視圖。支持搜索中英文產(chǎn)品名稱快速導(dǎo)航到對應(yīng)產(chǎn)品,或者單擊云產(chǎn)品名稱,打開對應(yīng)的 API 列表并支持搜索目標(biāo) API。
API 文檔查看
單擊 API 打開一個(gè)新的窗口,并顯示對應(yīng)的 API 文檔內(nèi)容,文檔包括接口說明、請求參數(shù)、響應(yīng)參數(shù)和錯(cuò)誤碼等信息。
API 調(diào)試
通過身份驗(yàn)證后,該插件可支持 API 調(diào)試。
可對照 API 文檔填寫參數(shù)表單進(jìn)行便捷的 API 調(diào)試,調(diào)試結(jié)果顯示在 IDE 中,或單擊去調(diào)試,快速跳轉(zhuǎn)到OpenAPI門戶控制臺(tái)的API接口進(jìn)行調(diào)試。
SDK 代碼示例的查看與插入
查看代碼示例
該插件支持生成SDK示例代碼。
填寫參數(shù)后,將同步生成對應(yīng)內(nèi)容的示例代碼,支持在 IDE 中快速打開示例代碼進(jìn)行編輯。
支持自動(dòng)導(dǎo)入依賴(目前支持自動(dòng)導(dǎo)入Maven依賴)。
單擊安裝方式和查看源碼按鈕可以獲取安裝依賴的方式和源碼的信息。
插入代碼片段
該插件目前支持一鍵插入 Java 和 Java 異步 SDK 示例代碼片段,并支持在pom文件自動(dòng)導(dǎo)入對應(yīng)的Maven依賴。可通過右鍵選擇ctrl+cmd+p
打開/關(guān)閉此功能。