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.
swagger-codegen -l html2 should include the basePath in the method headline/definition? · swagger-api/swagger-codegen#5167 | Good First Issue