OpenAPI生成器:通过标签选择或跳过API

问题描述 投票:0回答:2

我有一个很大的 OpenAPI 文件,其中有很多用 API 列表标记的方法,例如:

tags:
  - name: Marketplace API
    description: APIs used in order to use Marketplace Payment Flow
  - name: Payment API
    description: Payment API V4. If your integration is using API V2, <a href="/docs/api-migration/payments/">go to migration guide</a>.
  - name: Payouts API
    description: This API allows a merchant to make transfers using a card or a token. He can also retrieve info about past payouts or the current payout balance.

是否有任何生成器参数或其他方式可以跳过我不需要生成的 API?

我当前的生成命令:

for generator in $(cat generator-list.txt)
do
    npx @openapitools/openapi-generator-cli generate \
        --input-spec https://***/docs/swagger/api/v4/docs.yml \
        --generator-name ${generator} \
        --output ./client_${generator} \
        --verbose
done
openapi code-generation swagger-codegen openapi-generator openapi-generator-cli
2个回答
4
投票

您可以使用

--global-property
来定义您想要的API、模型或支持文件

openapi-generator-cli generate -i specfile.yml -g go \ 
    --global-property apis="tag1:tag2:tag3"

参见 OpenAPI 生成器 定制页面


0
投票

答案可能是使用

.openapi-generator-ignore
: 假设您只想要模型。那么内容一定是:

# Don't generate api code
api/*
# Don't generate supporting code
*.ts
*.json
*.sh
*.md

我用过这个,你瞧,它有效。

© www.soinside.com 2019 - 2024. All rights reserved.