swagger-api/swagger-codegen

Generate .jmx (Jmeter file) from .yaml

Open

#8,313 opened on Jun 13, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)HTML (5,474 forks)batch import
help wanted

Repository metrics

Stars
 (12,701 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hi everyone, I try to create my own template (api.mustache) in order to generate a .jmx (Jmeter test file) to test my API REST. My problem is to collect aproperties of a body type object parameter.

Here is a part of my .yaml :

/dossiers/{dossierId}/dossiers:
    post:
      tags:
      - DossierService
      summary: Ajouter un sous-dossier.
      operationId: addDossier
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: dossier
        in: body
        required: true
        schema:
          type: object
          required:
          - name
          properties:
            name:
              type: string
              maxLength: 200
              description: Le nom du nouveau dossier.

I want to extract the string "name" who is in properties of parameter "Dossier", but I can't do that...

When I use this code in my api.mustache, my variable {{basename}} is equal at "Dossier"...

{{#operations}}
{{#operation}}
{{#bodyParams}}
			   <elementProp name="{{baseName}}" elementType="HTTPArgument">
{{/bodyParams}}
{{/operation}}
{{/operations}}

I used DebugOperation et DebugModel to identify which variable I can use and i see my name variable in DebugModel but I can't use it (I tried use {{#models}}, {{#model}}, {{#var}}, etc...)

Somebody can help me ??

Mickael

Swagger-codegen version --> swagger-codegen-2.3.1

Contributor guide

Research direction
Examine the mustache template context in swagger codegen's code generation. The user reports that 'baseName' resolves to 'Dossier' but they need the properties inside the schema object. Look at how the 'model' variable is structured in the debug output; it likely contains a list of models. Investigate the '{{#model}}' and '{{#vars}}' sections to access nested property names. Consider looking at existing templates (e.g., Java client templates) that iterate over model properties for reference. The issue may require modifying the template to access the schema's properties via '{{#model}}{{#vars}}{{name}}{{/vars}}{{/model}}' or similar.
Tech stack
None
Domain
apitooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Needs investigation
Prerequisites
mustache templatingswagger codegen template system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30