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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
# -*- coding: utf-8 -*-
# @Author : llc
# @Time : 2021/5/17 15:25
from typing import Optional
import pytest
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)
app.config["TESTING"] = True
tag = Tag(name='book', description="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}
)
try:
api.register_api(api)
except ValueError as e:
assert str(e) == "Cannot register a api blueprint on itself"
@pytest.fixture
def client():
client = app.test_client()
return client
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 BookPath(BaseModel):
bid: int = Field(..., description='book id')
@api.post('/book', doc_ui=False)
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: BookPath, body: BookBody):
assert path.bid == 1
assert body.age == 3
return {"code": 0, "message": "ok"}
@api.patch('/book/<int:bid>')
def update_book1(path: BookPath, body: BookBody):
assert path.bid == 1
assert body.age == 3
return {"code": 0, "message": "ok"}
@api.patch('/v2/book/<int:bid>')
def update_book1_v2(path: BookPath, body: BookBody):
assert path.bid == 1
assert body.age == 3
return {"code": 0, "message": "ok"}
@api.delete('/book/<int:bid>')
def delete_book(path: BookPath):
assert path.bid == 1
return {"code": 0, "message": "ok"}
# register api
app.register_api(api)
def test_openapi(client):
resp = client.get("/openapi/openapi.json")
assert resp.status_code == 200
assert resp.json == app.api_doc
assert resp.json["paths"]["/api/book/{bid}"]["put"]["operationId"] == "update"
assert resp.json["paths"]["/api/book/{bid}"]["delete"]["operationId"] == "_book_book__int_bid__delete"
def test_post(client):
resp = client.post("/api/book", json={"age": 3})
assert resp.status_code == 200
def test_put(client):
resp = client.put("/api/book/1", json={"age": 3})
assert resp.status_code == 200
def test_patch(client):
resp = client.patch("/api/book/1", json={"age": 3})
assert resp.status_code == 200
resp = client.patch("/api/v2/book/1", json={"age": 3})
assert resp.status_code == 200
def test_delete(client):
resp = client.delete("/api/book/1")
assert resp.status_code == 200
|
