Daily fix (#1)

Author: luolingchun

.github/workflows/docs.yml

@@ -21,5 +21,5 @@ jobs:
           git config --local user.email "action@github.com"
           git config --local user.name "GitHub Action"
           git fetch origin gh-pages:gh-pages
-          uv run mike deploy v0.9.x
+          uv run mike deploy v0.x latest --update-aliases
           git push origin gh-pages

README.md

@@ -5,7 +5,7 @@
     </a>
 </div>
 <p align="center">
-    <em>A simple API framework based on Starlette.</em>
+    <em>A simple async API framework based on Starlette.</em>
 </p>
 <p align="center">
     <a href="https://github.com/luolingchun/star-openapi/actions/workflows/tests.yml" target="_blank">
@@ -36,6 +36,8 @@ The key features are:
 
 - **Data validation:** Fast data verification based on [Pydantic](https://github.com/pydantic/pydantic)
 
+- **Websocket**: Support for websocket
+
 ## Requirements
 
 Python 3.11+

docs/Example.md

@@ -180,7 +180,7 @@ if __name__ == "__main__":
     uvicorn.run(app, host="127.0.0.1", port=8000)
 ```
 
-## APIBlueprint
+## APIRouter
 
 ```python
 from pydantic import BaseModel, Field

docs/Usage/Request.md

@@ -77,6 +77,9 @@ Receive request headers.
 
 Receive request cookies.
 
+### request
+
+Receive request from **starlette.requests.Request**.
 
 ## Request model
 

examples/simple_demo.py

@@ -15,14 +15,15 @@ class TestModel(BaseModel):
     age: int
 
 
-@app.post("/book", summary="get books", tags=[book_tag])
-async def create_user(body: TestModel):
+@app.get("/book", summary="get books", tags=[book_tag])
+async def get_book(query: TestModel):
     """
     get all books
     """
-    print(body.model_dump_json())
+    print(query.model_dump_json())
     return JSONResponse({"message": "Hello World"})
 
+
 if __name__ == "__main__":
     print(app.routes)
     uvicorn.run(app)

pyproject.toml

@@ -1,7 +1,8 @@
 [project]
 name = "star-openapi"
 dynamic = ["version"]
-description = "A simple API framework based on Starlette."
+description = "A simple async API framework based on Starlette."
+readme = "README.md"
 maintainers = [{ name = "llc", email = "luolingchun@outlook.com" }]
 license = "MIT"
 license-files = ["LICENSE"]
@@ -31,8 +32,6 @@ dependencies = [
     "jinja2>=3.1.2",
     "uvicorn[standard]>=0.40.0",
     "click>=8.0.0",
-    "cython>=3.2.3",
-    "setuptools>=80.9.0",
 ]
 
 [project.optional-dependencies]

star_openapi/openapi.py

@@ -254,7 +254,7 @@ def register_api(self, api: APIRouter):
 
         self.paths.update(**api.paths)
 
-        # Update component schemas with the APIBlueprint's component schemas
+        # Update component schemas with the APIRouter's component schemas
         self.components_schemas.update(**api.components_schemas)
 
         # Register the APIRouter with the current instance

star_openapi/router.py

@@ -62,7 +62,7 @@ def register_api(self, api: "APIRouter"):
 
         self.paths.update(**api.paths)
 
-        # Update component schemas with the APIBlueprint's component schemas
+        # Update component schemas with the APIRouter's component schemas
         self.components_schemas.update(**api.components_schemas)
 
         # Register the APIRouter with the current instance

star_openapi/utils.py

@@ -89,7 +89,7 @@ def get_operation_id_for_path(*, url_prefix: str = "", name: str = "", path: str
     Generate a unique operation ID based on the name, path, and method.
 
     Args:
-        url_prefix: The Blueprint name
+        url_prefix: The APIRouter name
         name: The name or identifier for the operation.
         path: The URL path for the operation.
         method: The HTTP method for the operation.