swagger-api/swagger-codegen

generated HTML contains invalid anchor links

Open

#5,087 建立於 2017年3月16日

在 GitHub 查看
 (5 留言) (0 反應) (0 負責人)HTML (12,701 star) (5,474 fork)batch import
Client: HTMLIssue: Bughelp wanted

描述

Description

generated HTML contains invalid anchor links on types of request parameters

Swagger-codegen version

current master; HEAD = 1c160df33897898da1c39f230c737eb6a313e6ba

Swagger declaration file content or url
swagger: "2.0"

info:
  title: swagger-codegen broken anchors to models
  version: '1.0'

definitions:
  foo:
    type: object
    properties:
      x:
        type: string

paths:
  /foo:
    get:
      parameters:
        - name: foo
          in: body
          description: foo
          schema: {$ref: "#/definitions/foo"}
      responses:
        "200":
          description: foo
          type: null
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 html -o foo

Note in the generated html the link's first letter is capital while the anchor is not. Using Firefox 51.0.1 (64-bit)

貢獻者指南

技術棧
html
領域
documentation
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic understanding of Mustache templatesHTML knowledge
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
The bug is that generated HTML links use capitalized first letter for model references, while the corresponding anchor IDs are lowercase. This inconsistency causes broken links. The likely cause is in the HTML template files (e.g., modules/swagger codegen/src/main/resources/htmlDocs2/index.mustache) where the link generation and anchor generation may use different formatting functions. Look for places where model names are transformed for anchors (often using `lowercaseFirst` or similar) versus links. The fix should apply the same transformation to both. Check the Mustache templates for any helper functions that handle model name casing. Also review the Swagger2HTMLGenerator.java or similar Java source that processes the data model. The issue reproduces with a simple swagger spec; ensure that after fixing, anchors work correctly.