swagger-api/swagger-codegen

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

Open

#5.167 geöffnet am 22. März 2017

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)HTML (5.474 Forks)batch import
Client: HTMLGeneral: Questionhelp wanted

Repository-Metriken

Stars
 (12.701 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Suchen Sie die html2 Mustache Vorlagendateien (wahrscheinlich unter modules/swagger codegen/src/main/resources/html2/). Finden Sie die Vorlage für die Methodenüberschrift (z. B. method.mustache). Stellen Sie fest, ob die basePath Variable bereits im Vorlagenkontext verfügbar ist; falls nicht, identifizieren Sie den Java Code, der die Vorlage füllt (z. B. DefaultCodegen oder verwandte Klassen), und fügen Sie basePath zum Kontext hinzu. Ändern Sie dann die Mustache Vorlage, um basePath in der Überschrift einzufügen. Testen Sie mit einer Beispielspezifikation, um Konsistenz mit der Anzeige des curl Befehls sicherzustellen.
Tech Stack
javahtml
Domain
backenddocumentation
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaGitMaven
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65