def schema_path_helper(spec, view, **kwargs):
"""Path helper that allows passing a Schema as a response. Responses can be
defined in a view's docstring.
"""
operations = (load_operations_from_docstring(view.__doc__)
or kwargs.get('operations'))
if not operations:
return
operations = operations.copy()
for operation in operations.values():
for response in operation.get('responses', {}).values():
if 'schema' in response:
response['schema'] = resolve_schema_dict(
spec, response['schema'])
return Path(operations=operations)
def schema_path_helper(spec, view=None, **kwargs):
"""Path helper that allows passing a Schema as a response. Responses can be
defined in a view's docstring.
::
from pprint import pprint
from my_app import Users, UserSchema
class UserHandler:
def get(self, user_id):
'''Get a user endpoint.
---
description: Get a user
responses:
200:
description: A user
schema: UserSchema
'''
user = Users.get(id=user_id)
schema = UserSchema()
return schema.dumps(user)
urlspec = (r'/users/{user_id}', UserHandler)
spec.add_path(urlspec=urlspec)
pprint(spec.to_dict()['paths'])
# {'/users/{user_id}': {'get': {'description': 'Get a user',
# 'responses': {200: {'description': 'A user',
# 'schema': {'$ref': '#/definitions/User'}}}}}}
::
from pprint import pprint
from my_app import Users, UserSchema
class UsersHandler:
def get(self):
'''Get users endpoint.
---
description: Get a list of users
responses:
200:
description: A list of user
schema:
type: array
items: UserSchema
'''
users = Users.all()
schema = UserSchema(many=True)
return schema.dumps(users)
urlspec = (r'/users', UsersHandler)
spec.add_path(urlspec=urlspec)
pprint(spec.to_dict()['paths'])
# {'/users': {'get': {'description': 'Get a list of users',
# 'responses': {200: {'description': 'A list of users',
# 'schema': {'type': 'array',
# 'items': {'$ref': '#/definitions/User'}}}}}}}
"""
operations = (
kwargs.get('operations') or
(view and load_operations_from_docstring(view.__doc__))
)
if not operations:
return None
operations = operations.copy()
return Path(operations=operations)