openapi v3 formatter

[Paxa]

It can generate valid openapi v3 json

run with:

rake swagger_v3

how to use example:

RSpec.configure do |config|
  config.swagger_docs = {
    'v2/swagger.json' => {
      openapi: '3.0.0',
      info: {
        title: 'API V2',
        version: 'v2'
      },
      servers: [{url: 'http://localhost:3000'}],

      components: {
        securitySchemes: { ... },
        schemas: {
          BasicRequest: {
            type: :object,
            properties: {
              user: { type: :string }
            },
            required: [:user]
          }
        }
      }
    }
  }
end

[drewish]

Oh neat! I'd toyed with trying to redo the module to fully take advantage of the OpenAPI v3 spec but hadn't gotten very far. I do like the idea of another formatter. Would you be open to adding some specs? I'm also thinking that it might be better to change the rake task name from swagger to openapi to reflect the upstream naming change.

[Paxa]

change the rake task name from swagger to openapi to reflect the upstream naming change
yep

I'm new to swagger and openapi, and implemented only changes that was needed for my use case. And some parts just use application/json without proper checking
Did you notice something need to be changed?

[Paxa]

Renamed v3 to openapi
Added tests for openapi
Add example with simple html file

[thg303]

why this is not merged yet??

[drewish]

@thg303 i appreciate the enthusiasm but it’d be more productive to chime in with what you’d done to test out the PR

[Paxa]

Since I'm not using this library anymore, any help to add tests is welcome