Migrating to Swagger 2.0

So you’re using pyramid_swagger with Swagger 1.2 and now it is time to upgrade to Swagger 2.0.

Just set the version of Swagger to support via configuration.

pyramid_swagger.swagger_versions = ['2.0']

If you would like to continue servicing Swagger 1.2 clients, pyramid_swagger has you covered.

pyramid_swagger.swagger_versions = ['1.2', '2.0']


When both versions of Swagger are supported, all requests are validated against the 2.0 version of the schema only. Make sure that your 1.2 and 2.0 schemas define an identical set of APIs.

If you’re not using an ini file, configuration in Python also works.

def main(global_config, **settings):
    # ...
    settings['pyramid_swagger.swagger_versions'] = ['2.0']
    # ...and so on with the other settings...
    config = Configurator(settings=settings)

Next, create a Swagger 2.0 version of your swagger schema. There are some great resources to help you with the conversion process.

Finally, place your Swagger 2.0 schema swagger.json file in the same directory as your Swagger 1.2 schema and you’re ready to go.

Incremental Migration

If your v1.2 spec is too large and you are looking to migrate specs incrementally, then the below config can be useful.

pyramid_swagger.prefer_20_routes = ['route_foo']


The above config is read only when both [‘1.2’, ‘2.0’] are present in swagger_versions config. If that is the case and the request’s route is present in prefer_20_routes, ONLY then the request is served through swagger 2.0 otherwise through 1.2. The only exception is either the config is not defined at all or both of the swagger versions are not enabled, in any of these cases, v2.0 is preferred (as mentioned in above note).