chore: add quart demo to readme (#268)

Signed-off-by: Keming <[email protected]> Signed-off-by: Keming <[email protected]>
0b01001001 · Oct 18, 2022 · 7ca58f9 · 7ca58f9
1 parent 54a2b1d
commit 7ca58f9
Show file tree

Hide file tree

Showing 8 changed files with 156 additions and 91 deletions.
diff --git a/README.md b/README.md
@@ -16,6 +16,7 @@ Yet another library to generate OpenAPI documents and validate requests & respon
 * Validate query, JSON data, response data with [pydantic](https://github.com/samuelcolvin/pydantic/) :wink:
 * Current support:
   * Flask [demo](#flask)
+  * Quart [demo](#quart)
   * Falcon [demo](#falcon)
   * Starlette [demo](#starlette)
 
@@ -274,20 +275,15 @@ from spectree import SpecTree, Response
 
 
 class Profile(BaseModel):
-    name: constr(min_length=2, max_length=40) # Constrained Str
-    age: int = Field(
-        ...,
-        gt=0,
-        lt=150,
-        description='user age(Human)'
-    )
+    name: constr(min_length=2, max_length=40)  # constrained str
+    age: int = Field(..., gt=0, lt=150, description="user age(Human)")
 
     class Config:
         schema_extra = {
             # provide an example
-            'example': {
-                'name': 'very_important_user',
-                'age': 42,
+            "example": {
+                "name": "very_important_user",
+                "age": 42,
             }
         }
 
@@ -297,44 +293,114 @@ class Message(BaseModel):
 
 
 app = Flask(__name__)
-api = SpecTree('flask')
+spec = SpecTree("flask")
 
 
-@app.route('/api/user', methods=['POST'])
-@api.validate(json=Profile, resp=Response(HTTP_200=Message, HTTP_403=None), tags=['api'])
+@app.route("/api/user", methods=["POST"])
+@spec.validate(
+    json=Profile, resp=Response(HTTP_200=Message, HTTP_403=None), tags=["api"]
+)
 def user_profile():
     """
     verify user profile (summary of this endpoint)
 
     user's name, user's age, ... (long description)
     """
-    print(request.context.json) # or `request.json`
-    return jsonify(text='it works') # or `Message(text='it works')`
+    print(request.context.json)  # or `request.json`
+    return jsonify(text="it works")  # or `Message(text='it works')`
 
 
 if __name__ == "__main__":
-    api.register(app) # if you don't register in api init step
+    spec.register(app)  # if you don't register in api init step
     app.run(port=8000)
-
 ```
 
 #### Flask example with type annotation
 
 ```python
 # opt in into annotations feature
-api = SpecTree("flask", annotations=True)
+spec = SpecTree("flask", annotations=True)
+
+
+@app.route("/api/user", methods=["POST"])
+@spec.validate(resp=Response(HTTP_200=Message, HTTP_403=None), tags=["api"])
+def user_profile(json: Profile):
+    """
+    verify user profile (summary of this endpoint)
+
+    user's name, user's age, ... (long description)
+    """
+    print(json)  # or `request.json`
+    return jsonify(text="it works")  # or `Message(text='it works')`
+```
+
+### Quart
+
+```py
+from quart import Quart, jsonify, request
+from pydantic import BaseModel, Field, constr
+
+from spectree import SpecTree, Response
+
+
+class Profile(BaseModel):
+    name: constr(min_length=2, max_length=40)  # constrained str
+    age: int = Field(..., gt=0, lt=150, description="user age")
+
+    class Config:
+        schema_extra = {
+            # provide an example
+            "example": {
+                "name": "very_important_user",
+                "age": 42,
+            }
+        }
+
+
+class Message(BaseModel):
+    text: str
+
+
+app = Quart(__name__)
+spec = SpecTree("quart")
+
+
+@app.route("/api/user", methods=["POST"])
+@spec.validate(
+    json=Profile, resp=Response(HTTP_200=Message, HTTP_403=None), tags=["api"]
+)
+async def user_profile():
+    """
+    verify user profile (summary of this endpoint)
+
+    user's name, user's age, ... (long description)
+    """
+    print(request.context.json)  # or `request.json`
+    return jsonify(text="it works")  # or `Message(text="it works")`
+
+
+if __name__ == "__main__":
+    spec.register(app)
+    app.run(port=8000)
+```
+
+#### Quart example with type annotation
+
+```python
+# opt in into annotations feature
+spec = SpecTree("quart", annotations=True)
 
 
-@app.route('/api/user', methods=['POST'])
-@api.validate(resp=Response(HTTP_200=Message, HTTP_403=None), tags=['api'])
+@app.route("/api/user", methods=["POST"])
+@spec.validate(resp=Response(HTTP_200=Message, HTTP_403=None), tags=["api"])
 def user_profile(json: Profile):
     """
     verify user profile (summary of this endpoint)
 
     user's name, user's age, ... (long description)
     """
-    print(json) # or `request.json`
-    return jsonify(text='it works') # or `Message(text='it works')`
+    print(json)  # or `request.json`
+    return jsonify(text="it works")  # or `Message(text='it works')`
 ```
 
 ### Falcon
@@ -348,60 +414,56 @@ from spectree import SpecTree, Response
 
 class Profile(BaseModel):
     name: constr(min_length=2, max_length=40)  # Constrained Str
-    age: int = Field(
-        ...,
-        gt=0,
-        lt=150,
-        description='user age(Human)'
-    )
+    age: int = Field(..., gt=0, lt=150, description="user age(Human)")
 
 
 class Message(BaseModel):
     text: str
 
 
-api = SpecTree('falcon')
+spec = SpecTree("falcon")
 
 
 class UserProfile:
-    @api.validate(json=Profile, resp=Response(HTTP_200=Message, HTTP_403=None), tags=['api'])
+    @spec.validate(
+        json=Profile, resp=Response(HTTP_200=Message, HTTP_403=None), tags=["api"]
+    )
     def on_post(self, req, resp):
         """
         verify user profile (summary of this endpoint)
 
         user's name, user's age, ... (long description)
         """
         print(req.context.json)  # or `req.media`
-        resp.media = {'text': 'it works'} # or `resp.media = Message(text='it works')`
+        resp.media = {"text": "it works"}  # or `resp.media = Message(text='it works')`
 
 
 if __name__ == "__main__":
-    app = falcon.API()
-    app.add_route('/api/user', UserProfile())
-    api.register(app)
+    app = falcon.App()
+    app.add_route("/api/user", UserProfile())
+    spec.register(app)
 
-    httpd = simple_server.make_server('localhost', 8000, app)
+    httpd = simple_server.make_server("localhost", 8000, app)
     httpd.serve_forever()
-
 ```
 
 #### Falcon with type annotations
 
 ```python
 # opt in into annotations feature
-api = SpecTree("falcon", annotations=True)
+spec = SpecTree("falcon", annotations=True)
 
 
 class UserProfile:
-    @api.validate(resp=Response(HTTP_200=Message, HTTP_403=None), tags=['api'])
+    @spec.validate(resp=Response(HTTP_200=Message, HTTP_403=None), tags=["api"])
     def on_post(self, req, resp, json: Profile):
         """
         verify user profile (summary of this endpoint)
 
         user's name, user's age, ... (long description)
         """
         print(req.context.json)  # or `req.media`
-        resp.media = {'text': 'it works'} # or `resp.media = Message(text='it works')`
+        resp.media = {"text": "it works"}  # or `resp.media = Message(text='it works')`
 ```
 
 ### Starlette
@@ -413,65 +475,69 @@ from starlette.routing import Route, Mount
 from starlette.responses import JSONResponse
 from pydantic import BaseModel, Field, constr
 from spectree import SpecTree, Response
+
 # from spectree.plugins.starlette_plugin import PydanticResponse
 
 
 class Profile(BaseModel):
     name: constr(min_length=2, max_length=40)  # Constrained Str
-    age: int = Field(
-        ...,
-        gt=0,
-        lt=150,
-        description='user age(Human)'
-    )
+    age: int = Field(..., gt=0, lt=150, description="user age(Human)")
 
 
 class Message(BaseModel):
     text: str
 
 
-api = SpecTree('starlette')
+spec = SpecTree("starlette")
 
 
-@api.validate(json=Profile, resp=Response(HTTP_200=Message, HTTP_403=None), tags=['api'])
+@spec.validate(
+    json=Profile, resp=Response(HTTP_200=Message, HTTP_403=None), tags=["api"]
+)
 async def user_profile(request):
     """
     verify user profile (summary of this endpoint)
 
     user's name, user's age, ... (long description)
     """
     print(request.context.json)  # or await request.json()
-    return JSONResponse({'text': 'it works'}) # or `return PydanticResponse(Message(text='it works'))`
+    return JSONResponse(
+        {"text": "it works"}
+    )  # or `return PydanticResponse(Message(text='it works'))`
 
 
 if __name__ == "__main__":
-    app = Starlette(routes=[
-        Mount('api', routes=[
-            Route('/user', user_profile, methods=['POST']),
-        ])
-    ])
-    api.register(app)
+    app = Starlette(
+        routes=[
+            Mount(
+                "api",
+                routes=[
+                    Route("/user", user_profile, methods=["POST"]),
+                ],
+            )
+        ]
+    )
+    spec.register(app)
 
     uvicorn.run(app)
-
 ```
 
 #### Starlette example with type annotations
 
 ```python
 # opt in into annotations feature
-api = SpecTree("flask", annotations=True)
+spec = SpecTree("flask", annotations=True)
 
 
-@api.validate(resp=Response(HTTP_200=Message, HTTP_403=None), tags=['api'])
+@spec.validate(resp=Response(HTTP_200=Message, HTTP_403=None), tags=["api"])
 async def user_profile(request, json=Profile):
     """
     verify user profile (summary of this endpoint)
 
     user's name, user's age, ... (long description)
     """
     print(request.context.json)  # or await request.json()
-    return JSONResponse({'text': 'it works'}) # or `return PydanticResponse(Message(text='it works'))`
+    return JSONResponse({"text": "it works"})  # or `return PydanticResponse(Message(text='it works'))`
 ```
 
 

diff --git a/examples/falcon_asgi_demo.py b/examples/falcon_asgi_demo.py
@@ -11,11 +11,10 @@
 logging.basicConfig(level=logging.DEBUG)
 logger = logging.getLogger()
 
-api = SpecTree(
+spec = SpecTree(
     "falcon-asgi",
     title="Demo Service",
     version="0.1.2",
-    unknown="test",
 )
 
 demo = Tag(name="demo", description="😊", externalDocs={"url": "https://github.com"})
@@ -50,7 +49,7 @@ class Ping:
     def check(self):
         pass
 
-    @api.validate(tags=[demo])
+    @spec.validate(tags=[demo])
     async def on_get(self, req, resp):
         """
         health check
@@ -65,7 +64,7 @@ class Classification:
     classification demo
     """
 
-    @api.validate(tags=[demo])
+    @spec.validate(tags=[demo])
     async def on_get(self, req, resp, source, target):
         """
         API summary
@@ -74,7 +73,7 @@ async def on_get(self, req, resp, source, target):
         """
         resp.media = {"msg": f"hello from {source} to {target}"}
 
-    @api.validate(
+    @spec.validate(
         query=Query, json=Data, resp=Response(HTTP_200=Resp, HTTP_403=BadLuck)
     )
     async def on_post(self, req, resp, source, target):
@@ -98,7 +97,7 @@ class FileUpload:
     file-handling demo
     """
 
-    @api.validate(form=File, resp=Response(HTTP_200=FileResp), tags=["file-upload"])
+    @spec.validate(form=File, resp=Response(HTTP_200=FileResp), tags=["file-upload"])
     async def on_post(self, req, resp):
         """
         post multipart/form-data demo
@@ -114,6 +113,6 @@ async def on_post(self, req, resp):
     app.add_route("/ping", Ping())
     app.add_route("/api/{source}/{target}", Classification())
     app.add_route("/api/file_upload", FileUpload())
-    api.register(app)
+    spec.register(app)
 
     uvicorn.run(app, log_level="info")