1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
# -*- coding: utf-8 -*-
# @Author : llc
# @Time : 2021/6/6 14:05
from typing import Optional
from pydantic import BaseModel, Field
from flask_openapi3 import APIBlueprint, OpenAPI
from flask_openapi3 import Tag, Info
info = Info(title='book API', version='1.0.0')
jwt = {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
security_schemes = {"jwt": jwt}
app = OpenAPI(__name__, info=info, security_schemes=security_schemes)
tag = Tag(name='book', description="Some Book")
security = [{"jwt": []}]
class Unauthorized(BaseModel):
code: int = Field(-1, description="Status Code")
message: str = Field("Unauthorized!", description="Exception Information")
api = APIBlueprint(
'/book',
__name__,
url_prefix='/api',
abp_tags=[tag],
abp_security=security,
abp_responses={"401": Unauthorized},
# disable openapi UI
doc_ui=True
)
class BookBody(BaseModel):
age: Optional[int] = Field(..., ge=2, le=4, description='Age')
author: str = Field(None, min_length=2, max_length=4, description='Author')
class Path(BaseModel):
bid: int = Field(..., description='book id')
@api.get('/book', doc_ui=False)
def get_book():
return {"code": 0, "message": "ok"}
@api.post('/book', responses={200: {"content": {"text/csv": {"schema": {"type": "string"}}}}})
def create_book(body: BookBody):
assert body.age == 3
return {"code": 0, "message": "ok"}
@api.put('/book/<int:bid>', operation_id='update')
def update_book(path: Path, body: BookBody):
assert path.bid == 1
assert body.age == 3
return {"code": 0, "message": "ok"}
# register api
app.register_api(api)
if __name__ == '__main__':
app.run(debug=True)
|
