-
-
Notifications
You must be signed in to change notification settings - Fork 74
/
falcon_demo.py
130 lines (103 loc) · 2.96 KB
/
falcon_demo.py
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
import logging
from random import random
from wsgiref import simple_server
import falcon
from pydantic import BaseModel, Field
from examples.common import File, FileResp, Query
from spectree import ExternalDocs, Response, SpecTree, Tag
logging.basicConfig(level=logging.DEBUG)
logger = logging.getLogger()
spec = SpecTree(
"falcon",
title="Demo Service",
version="0.1.2",
description="This is a demo service.",
terms_of_service="https://github.io",
contact={"name": "John", "email": "[email protected]", "url": "https://github.com"},
license={"name": "MIT", "url": "https://opensource.org/licenses/MIT"},
)
demo = Tag(
name="demo", description="😊", externalDocs=ExternalDocs(url="https://github.com")
)
class Resp(BaseModel):
label: int = Field(
...,
ge=0,
le=9,
)
score: float = Field(
...,
gt=0,
lt=1,
)
class BadLuck(BaseModel):
loc: str
msg: str
typ: str
class Data(BaseModel):
uid: str
limit: int
vip: bool
class Ping:
def check(self):
pass
@spec.validate(tags=[demo])
def on_get(self, req, resp):
"""
health check
"""
self.check()
logger.debug("ping <> pong")
resp.media = {"msg": "pong"}
class Classification:
"""
classification demo
"""
@spec.validate(tags=[demo])
def on_get(self, req, resp, source, target):
"""
API summary
description here: test information with `source` and `target`
"""
resp.media = {"msg": f"hello from {source} to {target}"}
@spec.validate(
query=Query, json=Data, resp=Response(HTTP_200=Resp, HTTP_403=BadLuck)
)
def on_post(self, req, resp, source, target):
"""
post demo
demo for `query`, `data`, `resp`, `x`
"""
logger.debug("%s => %s", source, target)
logger.info(req.context.query)
logger.info(req.context.json)
if random() < 0.5:
resp.status = falcon.HTTP_403
resp.media = {"loc": "unknown", "msg": "bad luck", "typ": "random"}
return
resp.media = {"label": int(10 * random()), "score": random()}
class FileUpload:
"""
file-handling demo
"""
@spec.validate(form=File, resp=Response(HTTP_200=FileResp), tags=["file-upload"])
def on_post(self, req, resp):
"""
post multipart/form-data demo
demo for 'form'
"""
file = req.context.form.file
resp.media = {"filename": file.filename, "type": file.type}
if __name__ == "__main__":
"""
cmd:
http :8000/ping
http ':8000/api/zh/en?text=hi' uid=neo limit=1 vip=true
"""
app = falcon.App()
app.add_route("/ping", Ping())
app.add_route("/api/{source}/{target}", Classification())
app.add_route("/api/file_upload", FileUpload())
spec.register(app)
httpd = simple_server.make_server("localhost", 8000, app)
httpd.serve_forever()