Могу ли я позволить swagger-codegen игнорировать некоторые параметры метода - PullRequest
Новая
       60

Могу ли я позволить swagger-codegen игнорировать некоторые параметры метода

0 голосов
/ 04 июля 2019

Я использую swagger-codegen в моей сборке maven для генерации интерфейсов Java для моего уровня REST.Это работает очень хорошо.Однако есть пара параметров, которые я хотел бы исключить из списка аргументов сгенерированного метода.

Вопрос

Можно ли разрешить 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
...