Package: tornado-swagger
PyPILinuxWindowstornado-swagger: Swagger API Documentation builder for tornado server.
Inspired
byaiohttp-swaggerpackage
(based on this package sources).Documentationhttps://github.com/mrk-andreev/tornado-swagger/wikiCodehttps://github.com/mrk-andreev/tornado-swaggerIssueshttps://github.com/mrk-andreev/tornado-swagger/issuesPython versionPython 3.7, 3.8, 3.9, 3.10, 3.11 nightlySwagger Language Specificationhttps://swagger.io/specification/v2/Installationpip install -U tornado-swaggerWhat’s tornado-swaggertornado-swagger is a plugin for tornado server that allow to document
APIs using Swagger show the Swagger-ui console ( default url /api/doc).importtornado.webfromtornado_swagger.modelimportregister_swagger_modelfromtornado_swagger.parameterimportregister_swagger_parameterclassPostsDetailsHandler(tornado.web.RequestHandler):defget(self,posts_id):"""
        ---
        tags:
        - Posts
        summary: Get posts details
        description: posts full version
        produces:
        - application/json
        parameters:
        -   $ref: '#/parameters/PostId'
        responses:
            200:
              description: list of posts
              schema:
                $ref: '#/definitions/PostModel'
        """@register_swagger_parameterclassPostId:"""
    ---
    name: posts_id
    in: path
    description: ID of post
    required: true
    type: string
    """@register_swagger_modelclassPostModel:"""
    ---
    type: object
    description: Post model representation
    properties:
        id:
            type: integer
            format: int64
        title:
            type: string
        text:
            type: string
        is_visible:
            type: boolean
            default: true
    """What’s new?Version 1.5.0Add allow_cors option [pull-73](https://github.com/mrk-andreev/tornado-swagger/pull/73) Thanks to[@MarkParker5](https://github.com/MarkParker5)Version 1.4.5Specify supported python versions: 3.7, 3.8, 3.9, 3.10, 3.11 and nightlyRemoveflake8-eradicate,flake8-isortfrom dev depsCreatemake test-in-dockerfor test application across python versionsVersion 1.4.4Fix path parsing with groups (skip + warning) [issue-58](https://github.com/mrk-andreev/tornado-swagger/issues/58)Version 1.4.3Update swagger-ui lib from3.37.2to4.13.2[issue-62](https://github.com/mrk-andreev/tornado-swagger/issues/62) [issue-61](https://github.com/mrk-andreev/tornado-swagger/issues/61)Version 1.4.2Update dev requirements (fix broken packages)Update PyYAML fromPyYAML==5.4toPyYAML>=5.4[issue-59](https://github.com/mrk-andreev/tornado-swagger/issues/59)Specify encoding intornado_swagger/setup.py::openVersion 1.4.1Fix pypi build (migrate README from md to rst)Version 1.4.0Add experimental openapi support (api_definition_version =
API_OPENAPI_3; examples/model_and_param_declaration_openapi3.py)Version 1.3.0Add swagger parameter ref (@register_swagger_parameter). Thanks to
[@Weltraumpenner](https://github.com/Weltraumpenner)Version 1.2.11Fix link to spec swagger.jsonissue.Version 1.2.10Update PyYAML version to 5.4 (Fix for CVE-2020-14343)Version 1.2.9Fix handler args name parsing (examples/args_recognize.py).
Thanks to [@reubinoff]Version 1.2.8Addsecurityto setup. Thanks to
[@daominwang](https://github.com/daominwang)Add black code formatterUpdate swagger-ui library to 3.37.2Add integrity attribute to script / link tagsRemove Python 3.5 supportVersion 1.2.7Add display_models param to setup (defaultModelsExpandDepth).
Thanks to [@Sloknatos](https://github.com/Sloknatos)Fix swagger-ui bundleCVE-2019-17495Specify supported python versions: 3.5, 3.6, 3.7, 3.8, nightlyVersion 1.2.6Fix issue withStaticFileHandler(https://github.com/mrk-andreev/tornado-swagger/pull/28)Version 1.2.5Update dependenciesPyYAML==5.3.1fix vulnerabilitiespytest==6.0.1,pytest-flake8==1.0.6fix test crashVersion 1.2.4Fix “index out of range issue for StaticFileHandler”
(https://github.com/mrk-andreev/tornado-swagger/issues/23)Version 1.2.3Fix\tbug in Windows
(https://github.com/mrk-andreev/tornado-swagger/issues/21)Version 1.2.1Support wrapped methodsRemove jinja2 from depsVersion 1.2.0Replace local js/css to cdnRemove static files servingVersion 1.1.0Swagger model definitionParameters filling in route pathSchema definitionexport_swagger(routes)as public functionUpdate frontendVersion 1.0.0First version releasedLicense