使用 Swagger 生成 API 客戶端代碼,通常是透過 Swagger 提供的 OpenAPI 規範定義來實現。以下是具體步驟:
Swagger Codegen 和 OpenAPI Generator 都支持從 OpenAPI 規範生成 API 客戶端代碼。
透過 Maven:
mvn io.swagger.codegen.v3:swagger-codegen-maven-plugin:generate
透過 npm 安裝 CLI 工具:
npm install -g swagger-codegen
透過 npm 安裝:
npm install -g @openapitools/openapi-generator-cli
透過 Homebrew(MacOS):
brew install openapi-generator
通常,API 提供者會提供 OpenAPI 規範文件(JSON 或 YAML 格式)。你可以從 Swagger UI 或 API 文件中下載 .json
或 .yaml
格式的 API 描述文件。
swagger-codegen generate -i <swagger-file>.json -l <language> -o <output-directory>
其中:
-i
指定輸入文件,例如 swagger-file.json
。-l
指定目標程式語言,例如 java
、python
、typescript
。-o
指定輸出目錄。openapi-generator-cli generate -i <swagger-file>.json -g <language> -o <output-directory>
其中:
-i
指定輸入文件(如 swagger-file.json
)。-g
指定生成器的語言,例如 java
、python
、typescript
等。-o
指定輸出目錄。生成完成後,可以在指定的輸出目錄中查看生成的 API 客戶端代碼。接著,你可以在專案中使用這些代碼來調用 API。