swagger-api/swagger-codegen

generated HTML contains invalid anchor links

Open

#5,087 opened on 2017年3月16日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)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
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.