OpenAPIを利用したPythonWebアプリケーション開発
4 likes9,499 views
The document outlines the work of a software engineer at Kabuku Inc., detailing expertise in Python, TypeScript, and Go, along with participation in various tech conferences. It also discusses the OpenAPI specification and its tools, including how to validate and unmarshal API schemas, especially focusing on a 'book' object schema. Several code examples illustrate the process of handling OpenAPI documents and their respective data validation.
![‣
26
Book:
type: object
required: [id]
properties:
id:
type: integer
title:
type: string
author:
type: string](https://image.slidesharecdn.com/20170909pyconjp2017-170909022945/85/OpenAPI-PythonWeb-26-320.jpg)
![‣
27
import yaml
from bravado_core.spec import Spec
# 1
with open('openapi.yaml', 'r') as f:
raw_spec = yaml.load(f)
# 2
spec = Spec.from_dict(raw_spec)
# 3
book = raw_spec['definitions']['Book']
# 4
validate_schema_object(spec, book, target)](https://image.slidesharecdn.com/20170909pyconjp2017-170909022945/85/OpenAPI-PythonWeb-27-320.jpg)
![‣
28
validate_schema_object(spec, book, {})
Code
jsonschema.exceptions.ValidationError: 'id' is a required property
Failed validating 'required' in schema:
{'properties': {'author': {'type': 'string'},
'id': {'type': 'integer'},
'release_date': {'format': 'date', 'type': 'string'},
'title': {'type': 'string'}},
'required': ['id'],
'type': 'object',
'x-model': 'Book'}
On instance:
{}
Result](https://image.slidesharecdn.com/20170909pyconjp2017-170909022945/85/OpenAPI-PythonWeb-28-320.jpg)
![‣
29
validate_schema_object(spec, book, {"id": 1, "title": 1})
Code
jsonschema.exceptions.ValidationError: 1 is not of type 'string'
Failed validating 'type' in schema['properties']['title']:
{'type': 'string'}
On instance['title']:
1
Result](https://image.slidesharecdn.com/20170909pyconjp2017-170909022945/85/OpenAPI-PythonWeb-29-320.jpg)
![‣
‣
30
from bravado_core.unmarshal import unmarshal_schema_object
book_obj = unmarshal_schema_object(
spec, book,
{"id": 1,
"title": "Merchant of Venice",
“author": "William Shakespeare"})
print(book_obj)
Code
]変換対象のデータ
Book(author='William Shakespeare', id=1, title='Merchant of Venice')
Result](https://image.slidesharecdn.com/20170909pyconjp2017-170909022945/85/OpenAPI-PythonWeb-30-320.jpg)
![‣
31
Book:
type: object
required: [id]
properties:
id:
type: integer
title:
type: string
author:
type: string
release_date:
type: string
format: date ]](https://image.slidesharecdn.com/20170909pyconjp2017-170909022945/85/OpenAPI-PythonWeb-31-320.jpg)
![‣
32
book_obj = unmarshal_schema_object(
spec, book,
{"id": 1,
"title": "Merchant of Venice",
"author": "William Shakespeare",
"release_date": "2017-07-11"})
print(book_obj)
Code
]変換対象のデータ
Book(author='William Shakespeare', id=1,
release_date=datetime.date(2017, 7, 11), title='Merchant of Venice')
Result](https://image.slidesharecdn.com/20170909pyconjp2017-170909022945/85/OpenAPI-PythonWeb-32-320.jpg)
![‣
‣
34
Book = spec.definitions['Book']
book_obj = Book(id=1, title="Merchant of Venice",
s
release_date=date(2017, 7, 11))
book_dict = marshal_schema_object(spec, book, book_obj)
print(book_dict)
]“Book” object
Code
{'release_date': '2017-07-11', 'title': 'Merchant of Venice', 'id': 1,
'author': 'William Shakespeare'}
Result](https://image.slidesharecdn.com/20170909pyconjp2017-170909022945/85/OpenAPI-PythonWeb-34-320.jpg)
OpenAPIを利用したPythonWebアプリケーション開発
- 2. Kabuku Inc. Software Engineer @taxpon taxpon http://takuro.ws - Python, TypeScript, Go, DevOps - EuroPython 2017, 2016, PyConJP 2015, Blender Conf 2015 - Swagger Codegen technical committee (Python, TypeScript) Takuro Wada
- 3. 3
- 8. 8 ‣ ‣ ‣ ‣ ‣
- 10. 10
- 11. 11
- 13. 13
- 14. OpenAPI Specification Swagger Core Swagger Parser Swagger Codegen Swagger UI Swagger Editor 3rd Party Tools OpenAPI Document （YAML or JSON) べんり！
- 15. ‣ ‣ ‣ ‣ 15 ‣ ‣ ‣
- 16. 16
- 17. 17
- 19. ‣ ‣ ‣ ‣ ‣ ‣ 19
- 20. ‣ ‣ ‣ 20
- 21. ‣ ‣ 21 COREツール
- 22. ‣ ‣ ‣ 22 COREツール
- 24. ‣ ‣ ‣ 24
- 25. ‣ ‣ ‣ ‣ ‣ ‣ ‣ 25
- 26. ‣ 26 Book: type: object required: [id] properties: id: type: integer title: type: string author: type: string
- 27. ‣ 27 import yaml from bravado_core.spec import Spec # 1 with open('openapi.yaml', 'r') as f: raw_spec = yaml.load(f) # 2 spec = Spec.from_dict(raw_spec) # 3 book = raw_spec['definitions']['Book'] # 4 validate_schema_object(spec, book, target)
- 28. ‣ 28 validate_schema_object(spec, book, {}) Code jsonschema.exceptions.ValidationError: 'id' is a required property Failed validating 'required' in schema: {'properties': {'author': {'type': 'string'}, 'id': {'type': 'integer'}, 'release_date': {'format': 'date', 'type': 'string'}, 'title': {'type': 'string'}}, 'required': ['id'], 'type': 'object', 'x-model': 'Book'} On instance: {} Result
- 29. ‣ 29 validate_schema_object(spec, book, {"id": 1, "title": 1}) Code jsonschema.exceptions.ValidationError: 1 is not of type 'string' Failed validating 'type' in schema['properties']['title']: {'type': 'string'} On instance['title']: 1 Result
- 30. ‣ ‣ 30 from bravado_core.unmarshal import unmarshal_schema_object book_obj = unmarshal_schema_object( spec, book, {"id": 1, "title": "Merchant of Venice", “author": "William Shakespeare"}) print(book_obj) Code ]変換対象のデータ Book(author='William Shakespeare', id=1, title='Merchant of Venice') Result
- 31. ‣ 31 Book: type: object required: [id] properties: id: type: integer title: type: string author: type: string release_date: type: string format: date ]
- 32. ‣ 32 book_obj = unmarshal_schema_object( spec, book, {"id": 1, "title": "Merchant of Venice", "author": "William Shakespeare", "release_date": "2017-07-11"}) print(book_obj) Code ]変換対象のデータ Book(author='William Shakespeare', id=1, release_date=datetime.date(2017, 7, 11), title='Merchant of Venice') Result
- 33. ‣ ‣ ‣ ‣ ‣ 33
- 34. ‣ ‣ 34 Book = spec.definitions['Book'] book_obj = Book(id=1, title="Merchant of Venice", s release_date=date(2017, 7, 11)) book_dict = marshal_schema_object(spec, book, book_obj) print(book_dict) ]“Book” object Code {'release_date': '2017-07-11', 'title': 'Merchant of Venice', 'id': 1, 'author': 'William Shakespeare'} Result
- 35. ‣ ‣ ‣ ‣ ‣ ‣ 35
- 37. ‣ ‣ ‣ 37
- 39. 39 Backend ServerFrontend API Kabuku Connect OpenAPI Other ServiceAPI Other Service OpenAPI Swagger codegen Swagger UI bravado-core ‣
- 40. 40 BackendFrontend API Kabuku Connect OpenAPI Other ServiceAPI Other Service OpenAPI Swagger codegen Swagger UI ‣
- 41. ‣ ‣ ‣ ‣ ‣ ‣ ‣ 41
- 42. ‣ ‣ ‣ ‣ ‣ ‣ 42
- 45. ‣ ‣ ‣ ‣ ‣ ‣ 45
- 46. ‣ ‣ ‣ ‣ 46