swagger-api/swagger-codegen

swagger-codegen -l html2 should include the basePath in the method headline/definition?

Open

#5,167 创建于 2017年3月22日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)HTML (12,701 star) (5,474 fork)batch import
Client: HTMLGeneral: Questionhelp wanted

描述

Description

swagger-codegen -l html2 should include the basePath in the method headline/definition?

Swagger-codegen version

current master; HEAD = 1c160df33897898da1c39f230c737eb6a313e6ba

Swagger declaration file content or url
swagger: '2.0'

info:
  title: "sscce"
  version: '1.0'
  description: sscce

basePath: /v1

paths:
  /foo:
    post:
      parameters:
        - name: foo
          in: params
          type: int
      responses:
        "200":
          description: foo
          type: string
Command line used for generation

JAR=".../swagger-codegen.git/modules/swagger-codegen-cli/target/swagger-codegen-cli.jar" java -jar "${JAR}" generate -i ~/sscce.yaml -l html2 -o foo

renders as

actual

Notice the incosistency between the first first black-background-rectangle and the curl command.

贡献者指南

技术栈
htmljava
领域
documentationfrontend
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Mustache template basicsswagger codegen template location
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
Locate the html2 Mustache template files (likely under modules/swagger codegen/src/main/resources/html2/). Find the template for the method headline (e.g., method.mustache). Determine if the basePath variable is already available in the template context; if not, identify the Java code that populates the template (e.g., DefaultCodegen or related classes) and add basePath to the context. Then modify the Mustache template to include basePath in the headline. Test with a sample spec to ensure consistency with the curl command display.