feature suggestion: derive yaml from an OpenAPI spec

[eykrehbein]

feature suggestion: derive yaml from an OpenAPI spec

[emckean]

so OAI (formerly known as Swagger) looks like this:

paths:
  /user/{userId}:
    get:
      summary: Returns a user by ID.
      parameters:
        - name: userId
          in: path
          required: true
          description: Parameter description in CommonMark or HTML.
          schema:
            type : integer
            format: int64
            minimum: 1
      responses: 
        '200':
          description: OK

so you can see that you can get 'method' , 'data:params', and so on out of the OAI spec. (You can also get 'url' from a different section.)

[eykrehbein]

Hi @emckean. What do you exactly mean by that?

[emckean]

more info here!

[lastlegion]

In favor of using the OpenAPI spec 👍

[jgroom33]

is the design goal to import from a OAI spec (i.e. create a templated strest.yml) or to use that spec in place of the existing schema?
If the goal is the latter, the OAI spec is not designed for data input so it would be best to make a suggestion on what an example would look like. like this:

paths:
  /user/{userId}:
    get:
      data:
        - userId: Env(some_env_variable)
      responses: 
        validate: '200'

^^^ doesn't make sense to me. Even if the more standard x- extension was used, it doesn't make sense use the OAI spec as a schema because the result would not conform with OAI if the strest test contains multiple calls to: GET /user/{userId}

IMO, it makes sense to have conversion.

[eykrehbein]

The OAI spec schema doesn't make that much sense for me neither

[jgroom33]

I recommend closing this. It should be implemented as a codegen function of swagger-codegen:
https://github.com/swagger-api/swagger-codegen

[jgroom33]

Maybe this could be easily modified to provide this function: https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/SwaggerYamlGenerator.java