概述

網關支持導入OAS2.0和OAS3.0格式的API定義，幫助用戶快速將現有系統的API接入網關。API網關既支持標準OAS格式的API定義的導入、也支持OAS定義擴展后的API定義導入。

導入標準OAS格式的API定義

導入API的流程主要包括:

• 選擇基本信息(必填)與全局配置(選填).
• 文本填寫或文件導入OAS 2.0或OAS 3.0格式的API定義.
• 進行預檢并根據檢查結果進行調整.
• 執行導入,成功導入后會生成對應的API和分組模型.

對應控制臺操作為:

1, 進入API托管->API管理菜單頁.

2, 在API列表頁點擊導入Swagger按鈕,進入API導入配置頁面.
a. 基本信息,必填

b. 全局配置,選填.主要是對入參請求模式,防止重放攻擊進行API全局設置。如果用戶OAS定義中通過擴展字段填寫了該配置信息,則優先使用用戶配置.

c. API定義,確定計劃導入的OAS定義內容，支持文本填入yaml或json格式的API定義內容,也支持上傳本地API定義文件。

3, 單擊預檢按鈕，系統將會對計劃導入的內容進行檢查，檢測出OAS定義中的API定義和模型定義，以及告警和錯誤信息。

4, 預檢過程中沒有錯誤信息和警告信息（或者忽略警告信息之后），可執行導入。單擊導入Swagger按鈕，系統真正開始導入API，導入API需要一定時間，導入過程請勿關閉瀏覽器。

5, 待系統執行完畢后，可查看到API導入結果。

標準OAS2.0格式與API網關的對應

本章節重點介紹OAS 2.0的格式定義與網關的API定義有對應的映射字段，對于沒有對應映射的OAS中的定義，不會影響API的導入。

1. Swagger Object：
   1. BasePath：對應分組的BasePath，導入時需要認證；
2. Path Item Object：
   1. Path：對應API定義中請求部分的請求path；
   2. Method：對應API定義中請求部分的Method，支持GET，POST，PUT，HEAD，DELETE，PATCH，OPTIONS；
3. Operation Object：
   1. Summary：對應API定義的描述；
   2. OperationId：對應API定義的API名稱，如果存在擴展字段“x-ctyun-apigateway-api-name”則使用擴展字段中的內容作為API的名稱；
   3. Schemes：對應API定義中請求部分支持的協議，優先級高于Swagger Object中的定義；
4. Parameter Object：
   1. Name：對應API定義中請求部分的參數名稱；
   2. In：對應API定義中請求部分的參數位置，支持path，query，head，formdata；
   3. Description：對應API定義中請求部分的參數描述；
   4. Required：對應API定義中請求部分的參數是否必填；
5. Response Object：
   1. HTTP Status Code：對應API定義中定義返回結果中錯誤碼定義中的錯誤碼；
   2. Description：對應API定義中定義返回結果中錯誤碼定義中的描述；
   3. Schema：對應API定義中定義返回結果中錯誤碼定義中的模型；
6. Definitions Object：
   該項定義中的對象，在導入的過程中，API網關會將模型創建在分組下，查看模型定義可以通過分組管理列表下，對應分組的操作欄中的模型管理查看。

標準OAS3.0格式與API網關的對應

本章節重點介紹OAS 3.0的格式定義與API網關的API定義有對應的映射字段，對于沒有對應映射的OAS中的定義，不會影響API的導入。

1. Path Item Object
   1. Path：對應API定義中請求部分的請求path；
   2. Method：對應API定義中請求部分的Method，支持GET，POST，PUT，HEAD，DELETE，PATCH，OPTIONS；
2. Operation Object
   1. Summary：對應API定義的描述；
   2. OperationId：對應API定義的API名稱，如果存在擴展字段“x-ctyun-apigateway-api-name”則使用擴展字段中的內容作為API的名稱；
3. Parameter Object
   1. Name：對應API定義中請求部分的參數名稱；
   2. In：對應API定義中請求部分的參數位置，支持path，query，head，formdata；
   3. Required：對應API定義中請求部分的參數是否必填；
4. Schema Object：
   1. Description：對應API定義中請求部分的參數描述；
   2. Type：對應API定義中請求部分的參數類型；
5. Responses Object
   1. HTTP Status Code：對應API定義中定義返回結果中錯誤碼定義中的錯誤碼；
   2. Description：對應API定義中定義返回結果中錯誤碼定義中的描述；
   3. Content：對應API定義中定義返回結果中錯誤碼定義中的模型；

導入具有API網關擴展字段的OAS格式定義

swagger支持導入具有API網關擴展字段的OAS格式定義