Directives¶

Extends specification with directives $include, $view and $handler.

$handler¶

Handler:

from aiohttp import web

async def handler(request):
    return web.json_response(
        {'test': 'Hello'}
    )

Swagger spec:

swagger: '2.0'

basePath: /api/1

paths:

  /hello:
    get:
      $handler: mymodule.handler
      summary: and other not required for working route

Equal:

app.router.add_route(
    'GET',
    '/api/1/hello',
    handler,
    name='mymodule.handler')

Root spec:

swagger: '2.0'

basePath: /api/1

paths:

  /user:
    - $include: swagger/user.yaml
    - $include: ...
    - $include: ...

Nested spec in file swagger/user.yaml:

swagger: '2.0'

paths:
  /profile:
    get:
      $handler: mymodule.handler
  /{id:\d+}:
    get:
      $handler: mymodule.handler2

Regardless of the value of the parameter default_validate this directive controls the need to validate the input data for the handler

swagger: '2.0'

paths:
  /profile:
    get:
      $validate: true
      $handler: mymodule.handler