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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
# -*- coding: utf-8 -*-
# @Author : llc
# @Time : 2022/11/4 14:41
import pytest
from pydantic import BaseModel, Field
from flask_openapi3 import APIView, Info, OpenAPI, Tag
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
security = [{"jwt": []}]
api_view = APIView(url_prefix="/api/v1/<name>", view_tags=[Tag(name="book")], view_security=security)
api_view2 = APIView(doc_ui=False)
api_view_no_url = APIView(view_tags=[Tag(name="book")], view_security=security)
class BookPath(BaseModel):
id: int = Field(..., description="book ID")
name: str
class BookQuery(BaseModel):
age: int | None = Field(None, description="Age")
class BookBody(BaseModel):
age: int | None = Field(..., ge=2, le=4, description="Age")
author: str = Field(None, min_length=2, max_length=4, description="Author")
@api_view.route("/book")
class BookListAPIView:
a = 1
@api_view.doc(summary="get book list", responses={204: None}, doc_ui=False)
def get(self, query: BookQuery):
print(self.a)
return query.model_dump_json()
@api_view.doc(summary="create book")
def post(self, body: BookBody):
"""description for a created book"""
return body.model_dump_json()
@api_view.route("/book/<id>")
class BookAPIView:
@api_view.doc(summary="get book")
def get(self, path: BookPath):
print(path)
return "get"
@api_view.doc(summary="update book", operation_id="update")
def put(self, path: BookPath):
print(path)
return "put"
@api_view.doc(summary="delete book", deprecated=True)
def delete(self, path: BookPath):
print(path)
return "delete"
@api_view2.route("/<name>/book2/<id>")
class BookAPIView2:
@api_view2.doc(summary="get book")
def get(self, path: BookPath):
return path.model_dump()
@api_view_no_url.route("/book3")
class BookAPIViewNoUrl:
@api_view_no_url.doc(summary="get book3")
def get(self, path: BookPath):
return path.model_dump()
app.register_api_view(api_view)
app.register_api_view(api_view2)
@pytest.fixture
def client():
client = app.test_client()
return client
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/v1/{name}/book/{id}"]["put"]["operationId"] == "update"
assert (
resp.json["paths"]["/api/v1/{name}/book/{id}"]["delete"]["operationId"] == "BookAPIView_delete_book__id__delete"
)
def test_get_list(client):
resp = client.get("/api/v1/name1/book")
assert resp.status_code == 200
def test_post(client):
resp = client.post("/api/v1/name1/book", json={"age": 3})
assert resp.status_code == 200
def test_put(client):
resp = client.put("/api/v1/name1/book/1", json={"age": 3})
assert resp.status_code == 200
def test_get(client):
resp = client.get("/api/v1/name1/book/1")
assert resp.status_code == 200
resp = client.get("/name2/book2/1")
assert resp.status_code == 200
def test_delete(client):
resp = client.delete("/api/v1/name1/book/1")
assert resp.status_code == 200
def create_app():
app = OpenAPI(__name__, info=info, security_schemes=security_schemes)
app.register_api_view(api_view, url_prefix="/api/1.0")
app.register_api_view(api_view_no_url, url_prefix="/api/1.0")
# Invoke twice to ensure that call is idempotent
create_app()
create_app()
def test_register_api_view_idempotency():
assert list(api_view.paths.keys()) == ["/api/1.0/api/v1/{name}/book", "/api/1.0/api/v1/{name}/book/{id}"]
assert list(api_view_no_url.paths.keys()) == ["/api/1.0/book3"]
|
