檢測到您已登錄華為云國際站賬號，為了您更好的體驗，建議您訪問國際站服務(wù)網(wǎng)站 http://m.cqfng.cn/intl/zh-cn
不再顯示此消息
檢測到您已登錄華為云國際站賬號，為了您更好的體驗，建議您訪問國際站服務(wù)網(wǎng)站 http://m.cqfng.cn/intl/zh-cn
不再顯示此消息
微服務(wù)API接口設(shè)計規(guī)范
目錄 文章目錄 目錄 API 實現(xiàn)方式 Design-First（設(shè)計優(yōu)先） Code-First（編碼優(yōu)先） API 設(shè)計規(guī)范 為用戶設(shè)計 API 識別 API 的目標(biāo) Mock API Server
微服務(wù)API接口設(shè)計規(guī)范 API設(shè)計原則 API設(shè)計規(guī)范 父主題： 微服務(wù)架構(gòu)設(shè)計
前言 RESTful API 設(shè)計規(guī)范是確保接口一致性、可維護性和易用性的關(guān)鍵。
特性二：規(guī)范設(shè)計，品質(zhì)保障，API設(shè)計規(guī)范性檢查 Swagger編輯模式下，支持API設(shè)計規(guī)范檢查；可設(shè)置無需檢查接口，靈活控制每個接口的規(guī)范檢查，保證API設(shè)計質(zhì)量。
API概覽 CSS提供的接口為符合RESTful API設(shè)計規(guī)范的自研接口。通過CSS的自研接口，您可以使用CSS的如表2所示的功能。 本服務(wù)已上線部分V2版本的API，請優(yōu)先使用V2版本的API。
編輯模式與API規(guī)范檢查 CodeArts API在API設(shè)計界面提供代碼編輯模式進行API設(shè)計，可使用yaml格式設(shè)計接口文檔。在編輯模式中CodeArts API提供API規(guī)范性檢查。 通過規(guī)范性檢查功能，可以形成統(tǒng)一的設(shè)計規(guī)范，避免API設(shè)計不一致，提高API設(shè)計質(zhì)量。
編輯模式與API規(guī)范檢查 CodeArts API在API設(shè)計界面提供代碼編輯模式進行API設(shè)計，可使用yaml格式設(shè)計接口文檔。在編輯模式中CodeArts API提供API規(guī)范性檢查。 通過規(guī)范性檢查功能，可以形成統(tǒng)一的設(shè)計規(guī)范，避免API設(shè)計不一致，提高API設(shè)計質(zhì)量。
文檔路徑缺省為http://app-url/resources/microservices/{服務(wù)名}.yaml 父主題： API設(shè)計規(guī)范
API概覽 CAE API為符合API設(shè)計規(guī)范的自研接口。 環(huán)境接口 表1 環(huán)境接口介紹 API 說明 獲取環(huán)境列表 此API用來獲取當(dāng)前項目下的環(huán)境列表。 創(chuàng)建環(huán)境 此API用來創(chuàng)建環(huán)境。 刪除環(huán)境 此API用來刪除對應(yīng)的環(huán)境。
API概覽 醫(yī)療智能體平臺所提供的API，均符合RESTful API設(shè)計規(guī)范，如表1所示。 臨床研究和藥物設(shè)計所提供的API，均符合RESTful API設(shè)計規(guī)范，如表2所示。
API概覽 DIS提供的接口為符合RESTful API設(shè)計規(guī)范的自研接口。 通過DIS的自研接口，您可以使用DIS的如API說明所示的功能。
API概覽 Koosearch提供的接口為符合RESTful API設(shè)計規(guī)范的自研接口。通過Koosearch的自研接口，您可以使用Koosearch的表1 接口說明所示的功能。 表1 接口說明 類型 說明 知識庫管理接口 知識庫管理等相關(guān)接口。
DLV所提供的接口均為符合RESTful API設(shè)計規(guī)范的自研接口。通過DLV的自研接口，您可以使用如表1所示的DLV功能。
API概覽 人臉識別服務(wù)所提供的API，均符合RESTful API設(shè)計規(guī)范，如表1所示。 表1 人臉識別API 類型 API 說明 人臉檢測 人臉檢測 人臉檢測是對輸入圖片進行人臉檢測和分析，輸出人臉在圖像中的位置、人臉關(guān)鍵屬性。
API概覽 TICS提供的接口為符合RESTful API設(shè)計規(guī)范的自研接口。 使用空間API可以查詢TICS空間的相關(guān)信息，如獲取空間列表、獲取計算節(jié)點列表等。
API概覽 AI科學(xué)計算服務(wù)所提供的API，均符合RESTful API設(shè)計規(guī)范，如表1所示。 表1 AI科學(xué)計算服務(wù)API 類型 API 說明 空間管理 空間管理 空間創(chuàng)建、獲取空間詳情、刪除空間等相關(guān)操作API。
HTTP/1.1 303 See other Content-Type: application/json Location: https://example.com/photos/4577 父主題： API設(shè)計規(guī)范
設(shè)計規(guī)范
None 產(chǎn)品介紹 CodeArts API 帶您了解CodeArts API 02:34 介紹CodeArts API 操作指導(dǎo) CodeArts API 介紹如何創(chuàng)建API設(shè)計及兩種設(shè)計編輯模式 03:20 創(chuàng)建API設(shè)計 CodeArts API 介紹如何設(shè)置API設(shè)計規(guī)范
