swagger-api/swagger-codegen

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

Open

#5.167 aberto em 22 de mar. de 2017

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)HTML (5.474 forks)batch import
Client: HTMLGeneral: Questionhelp wanted

Métricas do repositório

Stars
 (12.701 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

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.

Guia do colaborador

Direção de pesquisa
Localize os arquivos de modelo Mustache html2 (provavelmente em modules/swagger codegen/src/main/resources/html2/). Encontre o modelo para o título do método (por exemplo, method.mustache). Determine se a variável basePath já está disponível no contexto do modelo; caso contrário, identifique o código Java que preenche o modelo (por exemplo, DefaultCodegen ou classes relacionadas) e adicione basePath ao contexto. Em seguida, modifique o modelo Mustache para incluir basePath no título. Teste com uma especificação de exemplo para garantir consistência com a exibição do comando curl.
Pilha de tecnologia
javahtml
Domain
backenddocumentation
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JavaGitMaven
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65