2

Maven ビルドで使用swagger-codegenして、REST レイヤーの Java インターフェイスを生成します。これは非常にうまく機能します。ただし、生成されたメソッドの引数リストから除外したいパラメーターがいくつかあります。

質問

swagger-codegen で特定のパラメーター (名前など) を除外することはできますか?

それ以外の

  • public Response getFromEndpoint(String userToken, String xRequestId, String foo)

私は取得したいです

  • public Response getFromEndpoint(String foo)

これらのパラメーターをドキュメントに残しておきたい

どうして

省略されたヘッダーをフィルターで使用しますが、その後、生成されたメソッドでは無関係になったので、そこには入れたくありません。
それらを除外できることには、新しいセキュリティ関連のパラメーターを追加した後、実装内のすべてのメソッド シグネチャを修正する必要がないという利点もあります。

私のセットアップ

pom.xml

<plugin>
    <groupId>io.swagger.codegen.v3</groupId>
    <artifactId>swagger-codegen-maven-plugin</artifactId>
    <version>3.0.0</version>

swagger.yaml

paths:
  /endpoint
    get:
      tags:
        - example
      operationId: getFromEndpoint
      parameters:
        - name: user-token
          in: header
          required: true
          schema:
            type: string
        - name: X-request-id
          in: header
          required: false
          schema:
            type: string
        - name: foo
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: sample response
          content:
            application/json:
              schema:
                type: string
4

0 に答える 0