Cornice Swagger

Cornice Swagger is an extension package for Cornice that allows generating an OpenAPI/Swagger specification from Cornice service definitions.

What does it do?

Cornice swagger builds a valid OpenAPI document with basically these things:

1. Path listing and parameters from service path definitions.
2. Methods defined from each service view.
3. Descriptions from view docstrings.
4. Parameters from request schemas when using cornice/colander validators on the view definition.
5. Produced content-types when using colander renderers.
6. Accepted content types when they are provided on view definitions.
7. Allow user defined tags and responses on view definitions.

Documentation content

• Quickstart
  • Installing
  • Using a scaffold
  • Show me a minimalist useful example
• Full Tutorial
  • Using the Pyramid Hook
  • Extracting path parameters
  • Extracting parameters from cornice schemas
  • Extracting produced types from renderers
  • Extracting accepted types from content_type field
  • Documenting responses
  • Documenting tags
  • Generating summaries with view docstrings
  • Custom Swagger UI <script> bootstrap
• Cornice Swagger API
  • Basic Generator
  • cornice_enable_openapi_view directive
  • cornice_enable_openapi_explorer directive
  • Generator Internals
  • Section Handlers
  • Colander converters
• Frequently Asked Questions (FAQ)
  • How to make a schema parameter not required?
  • How to define a schema with additionalAttributes?
  • How do I integrate Swagger UI?
  • How do I work with colander schemas that require bound properties?

• Changelog
• Contributors

Contribution & Feedback

You can find us at Github or the Slack chat.

• GitHub Repository: https://github.com/Cornices/cornice.ext.swagger
• Slack chat: https://corniceswagger.herokuapp.com

You may also try the Cornice Mailing List:

• Cornice Developers Mailing List: https://mail.mozilla.org/listinfo/services-dev