iT邦幫忙

2024 iThome 鐵人賽

DAY 20
0
生成式 AI

API: Swagger, Postman系列 第 20

使用 Swagger 生成 API 客戶端代碼。

  • 分享至 

  • xImage
  •  

使用 Swagger 生成 API 客戶端代碼,通常是透過 Swagger 提供的 OpenAPI 規範定義來實現。以下是具體步驟:

1. 安裝 Swagger Codegen 或 OpenAPI Generator

Swagger Codegen 和 OpenAPI Generator 都支持從 OpenAPI 規範生成 API 客戶端代碼。

Swagger Codegen 安裝:

  • 透過 Maven:

    mvn io.swagger.codegen.v3:swagger-codegen-maven-plugin:generate
    
  • 透過 npm 安裝 CLI 工具:

    npm install -g swagger-codegen
    

OpenAPI Generator 安裝:

  • 透過 npm 安裝:

    npm install -g @openapitools/openapi-generator-cli
    
  • 透過 Homebrew(MacOS):

    brew install openapi-generator
    

2. 下載或取得 OpenAPI 規範文件

通常,API 提供者會提供 OpenAPI 規範文件(JSON 或 YAML 格式)。你可以從 Swagger UI 或 API 文件中下載 .json.yaml 格式的 API 描述文件。

3. 生成 API 客戶端代碼

使用 Swagger Codegen:

swagger-codegen generate -i <swagger-file>.json -l <language> -o <output-directory>

其中:

  • -i 指定輸入文件,例如 swagger-file.json
  • -l 指定目標程式語言,例如 javapythontypescript
  • -o 指定輸出目錄。

使用 OpenAPI Generator:

openapi-generator-cli generate -i <swagger-file>.json -g <language> -o <output-directory>

其中:

  • -i 指定輸入文件(如 swagger-file.json)。
  • -g 指定生成器的語言,例如 javapythontypescript 等。
  • -o 指定輸出目錄。

4. 驗證生成的代碼

生成完成後,可以在指定的輸出目錄中查看生成的 API 客戶端代碼。接著,你可以在專案中使用這些代碼來調用 API。


上一篇
在 Swagger 中測試 API:運行和調試。
下一篇
如何在 Swagger 中管理 API 版本。
系列文
API: Swagger, Postman30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言