Skip to main content

Build routes using swagger specification

Project description

https://travis-ci.org/aamalev/aiohttp_apiset.svg?branch=master https://codecov.io/gh/aamalev/aiohttp_apiset/branch/master/graph/badge.svg https://img.shields.io/pypi/v/aiohttp_apiset.svg Documentation Status

Package to build routes and validate request using swagger specification.

Features

  • Building of the routing from specification swagger

  • Using inclusions other specifications with concatenate url

  • Optional output of the resulting specification and view embed swagger-ui

  • Advanced router with TreeResource

  • Extract specify parameters from request and validate with jsonschema

  • Serialize data as response with middleware

Usecase

Package aiohttp_apiset allows supports several strategies:

  • The foreign specification. When the specification is made and maintained by another team.

  • The specification in the code. When the fragments of specification are placed in the docstrings.

  • Mixed strategy. When routing are located in the specification files and operations are described in the docstrings.

Examples: examples

History

0.5.2 (2017-06-21)

  • Add method Jsonify.resolve_exception

  • Add class Validator with method factory

0.5.1 (2017-06-20)

  • Param default_options_handler

  • Refactoring middleware jsonify

  • Now require aiohttp>=1.2

0.5.0 (2017-06-16)

  • fix naming SubLocation

  • add to Sublocation add_route

  • swagger-ui.min.js as default instead swagger-ui.js

  • default tag ‘default’ instead ‘without swagger’

  • kwargs as parts in sublocation.url

0.4.5 (2017-05-27)

  • Default show single spec in ui

  • URL filtering for generated specifications by spec param

0.4.4 (2017-05-26)

  • Fix swagger-ui prefix

0.4.3 (2017-05-26)

  • Use default value for array when collectionFormat is brackets or multi (#9)

  • Back swagger-ui to 2.x

0.4.2 (2017-04-28)

  • Up swagger-ui and fix prefix static url

  • Support for decimal in JsonEncoder

0.4.1 (2017-03-26)

  • Added check for similar patterns on one location

  • Fix static return default if filename empty

0.4.0 (2017-03-22)

  • TreeUrlDispatcher is stand-alone router

  • swagger_ui param now str url location for swagger-ui

  • spec query param for swagger-ui location to point to basePath

  • Take into account the default value for array parameters (Alain Leufroy #6)

  • Extract docstring swagger data in route_factory

  • Compatibility with py36 and aiohttp2.0

0.3.4 (2016-12-20)

  • fixed swagger extractor from docstring

  • support aiohttp 1.2

0.3.3 (2016-12-16)

  • Added support pathlib

  • Drop deprecated methods in views

0.3.2 (2016-12-14)

  • Added support for collectionFormat (#4)

0.3.1 (2016-11-25)

  • fix zero for number parameter

  • transfer validation errors into client handler if specified argument errors

0.3.0 (2016-11-24)

  • Added class OperationIdMapping and param operationId_mapping in SwaggerRouter.include for load authentic specification with specify operationId (#2)

  • Fixed validation form with file

  • Fixed overriding basePath

  • Added jinja2 decorator for working with aiohttp_jinja2

  • Loading operation body from docstring

  • Blank string param for number and integer treated as a missed

0.2.5 (2016-11-08)

0.2.4 (2016-11-06)

  • Added verbosity errors validate with jsonschema

0.2.3 (2016-11-05)

  • Added compatibility with aiohttp >= 1.1

  • Added safe decode form and json

  • Fixed extract body

0.2.2 (2016-10-28)

  • Fixed convertation from match_info

0.2.1 (2016-10-27)

  • Output conversion parameter errors in response

  • Fix validation

0.2.0 (2016-10-26)

0.1.13 (2016-05-02)

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiohttp_apiset-0.5.2.1.tar.gz (1.0 MB view details)

Uploaded Source

File details

Details for the file aiohttp_apiset-0.5.2.1.tar.gz.

File metadata

File hashes

Hashes for aiohttp_apiset-0.5.2.1.tar.gz
Algorithm Hash digest
SHA256 cd16ba104e870e803b6b33023293c3ba76fbfabd15c41b9bbadcd1643793825a
MD5 787a8a9470e2c207993078c890e4528f
BLAKE2b-256 29a0cf3f1dc5a1a21b2e81ea4c9618f886ece823afb22a7a2fe04040fc12ad02

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page