Merge pull request #5 from mr-fatalyst/0.4.0-dev

0.4.0 dev

Author: mr-fatalyst

CHANGELOG.md

@@ -4,6 +4,21 @@ All notable changes to FastOpenAPI are documented in this file.
 
 FastOpenAPI follows the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.
 
+## [0.4.0] - 2025-03-20
+
+### Added
+- `ReDoc UI` and default URL (`host:port/redoc`)
+- `TornadoRouter` for integration with the `Tornado` framework
+
+### Changed
+- Revised and updated all tests.
+
+### Fixed
+- Status code for error response fixed: 422 -> 500
+
+### Removed
+- Removed the `add_docs_route` and `add_openapi_route` from `BaseRouter`.
+
 ## [0.3.1] - 2025-03-15
 
 ### Fixed

README.md

@@ -6,6 +6,10 @@
   <b>FastOpenAPI</b> is a library for generating and integrating OpenAPI schemas using Pydantic and various frameworks.
 </p>
 
+<p align="center">
+  This project was inspired by <a href="https://fastapi.tiangolo.com/">FastAPI</a> and aims to provide a similar developer-friendly experience.
+</p>
+
 <p align="center">
   <img src="https://img.shields.io/github/license/mr-fatalyst/fastopenapi">
   <img src="https://github.com/mr-fatalyst/fastopenapi/actions/workflows/master.yml/badge.svg">
@@ -37,6 +41,9 @@ pip install fastopenapi[sanic]
 ```bash
 pip install fastopenapi[starlette]
 ```
+```bash
+pip install fastopenapi[tornado]
+```
 
 ---
 
@@ -62,7 +69,7 @@ pip install fastopenapi[starlette]
     from fastopenapi.routers import FalconRouter
 
     app = falcon.asgi.App()
-    router = FalconRouter(app=app, docs_url="/docs/", openapi_version="3.0.0")
+    router = FalconRouter(app=app)
 
 
     class HelloResponse(BaseModel):
@@ -80,7 +87,7 @@ pip install fastopenapi[starlette]
     ```
   </details>
 
-- ![Flask](https://img.shields.io/badge/-Flask-000000?style=flat&logo=flask&logoColor=white)
+- ![Flask](https://img.shields.io/badge/-Flask-EEEEEE?style=flat&logo=flask&logoColor=black)
   <details>
     <summary>Click to expand the Flask Example</summary>
 
@@ -91,7 +98,7 @@ pip install fastopenapi[starlette]
     from fastopenapi.routers import FlaskRouter
 
     app = Flask(__name__)
-    router = FlaskRouter(app=app, docs_url="/docs/", openapi_version="3.0.0")
+    router = FlaskRouter(app=app)
 
 
     class HelloResponse(BaseModel):
@@ -120,7 +127,7 @@ pip install fastopenapi[starlette]
     from fastopenapi.routers import QuartRouter
 
     app = Quart(__name__)
-    router = QuartRouter(app=app, docs_url="/docs/", openapi_version="3.0.0")
+    router = QuartRouter(app=app)
 
 
     class HelloResponse(BaseModel):
@@ -149,7 +156,7 @@ pip install fastopenapi[starlette]
     from fastopenapi.routers import SanicRouter
 
     app = Sanic("MySanicApp")
-    router = SanicRouter(app=app, docs_url="/docs/", openapi_version="3.0.0")
+    router = SanicRouter(app=app)
 
 
     class HelloResponse(BaseModel):
@@ -167,7 +174,7 @@ pip install fastopenapi[starlette]
     ```
   </details>
 
-- ![Starlette](https://img.shields.io/badge/-Starlette-4B0082?style=flat&logo=fastapi&logoColor=white)
+- ![Starlette](https://img.shields.io/badge/-Starlette-4B0082?style=flat&logo=python&logoColor=white)
   <details>
     <summary>Click to expand the Starlette Example</summary>
 
@@ -179,7 +186,7 @@ pip install fastopenapi[starlette]
     from fastopenapi.routers import StarletteRouter
 
     app = Starlette()
-    router = StarletteRouter(app=app, docs_url="/docs/", openapi_version="3.0.0")
+    router = StarletteRouter(app=app)
 
 
     class HelloResponse(BaseModel):
@@ -196,6 +203,43 @@ pip install fastopenapi[starlette]
     ```
   </details>
 
+- ![Tornado](https://img.shields.io/badge/-Tornado-2980B9?style=flat&logo=python&logoColor=white)
+  <details>
+    <summary>Click to expand the Tornado Example</summary>
+    
+    ```python
+    import asyncio
+  
+    from pydantic import BaseModel
+    from tornado.web import Application
+  
+    from fastopenapi.routers.tornado import TornadoRouter
+  
+    app = Application()
+  
+    router = TornadoRouter(app=app)
+  
+  
+    class HelloResponse(BaseModel):
+        message: str
+  
+  
+    @router.get("/hello", tags=["Hello"], status_code=200, response_model=HelloResponse)
+    def hello(name: str):
+        """Say hello from Tornado"""
+        return HelloResponse(message=f"Hello, {name}! It's Tornado!")
+  
+  
+    async def main():
+        app.listen(8000)
+        await asyncio.Event().wait()
+  
+  
+    if __name__ == "__main__":
+        asyncio.run(main())
+    ```
+  </details>
+
 ### Step 2. Run the server
 
 Launch the application:
@@ -206,16 +250,21 @@ python main.py
 
 Once launched, the documentation will be available at:
 
+Swagger UI:
+```
+http://127.0.0.1:8000/docs
 ```
-http://127.0.0.1:8000/docs/
+ReDoc UI:
+```
+http://127.0.0.1:8000/redoc
 ```
 
 ---
 
 ## ⚙️ Features
 - **Generate OpenAPI schemas** with Pydantic v2.
 - **Data validation** using Pydantic models.
-- **Supports multiple frameworks:** Falcon, Flask, Quart, Sanic, Starlette.
+- **Supports multiple frameworks:** Falcon, Flask, Quart, Sanic, Starlette, Tornado.
 - **Proxy routing provides FastAPI-style routing**
 
 ---
@@ -232,6 +281,12 @@ Examples of integration and detailed usage for each framework are available in t
 
 ---
 
+## 📊 Quick & Dirty Benchmarks
+
+Fast but not perfect benchmarks. Check the [`benchmarks`](https://github.com/mr-fatalyst/fastopenapi/tree/master/benchmarks) directory for details.
+
+---
+
 ## ✅ Development Recommendations
 
 - Use Pydantic models for strict typing and data validation.

benchmarks/README.md

@@ -0,0 +1,73 @@
+## 📊 Quick & Dirty Benchmarks
+
+This benchmark compares the performance of two API implementations:  
+- **Original**: Uses standard routing with Pydantic validation.  
+- **FastOpenAPI**: Uses proxy routing with Pydantic validation.
+
+Each implementation runs in a separate instance, and the benchmark measures response times across multiple endpoints.
+
+### 📈 Rough results
+- You can check rough results here:
+  - [Falcon](falcon/FALCON.md)
+  - [Flask](flask/FLASK.md)
+  - [Quart](quart/QUART.md)
+  - [Sanic](sanic/SANIC.md)
+  - [Starlette](starlette/STARLETTE.md)
+  - [Tornado](tornado/TORNADO.md)
+
+### 📖 How It Works
+- The script runs **10,000 requests per endpoint**. You can set your own value.
+- It tests **GET, POST, PUT, PATCH, and DELETE** operations.
+- For DELETE, it first creates a temporary record to ensure valid deletion.
+- Results are printed and compared in a summary table.
+
+### 📂 Benchmark Structure
+- The main benchmark script is in `benchmarks/benchmark.py`.
+- Test applications are organized in separate folders (`without_fastopenapi/` and `with_fastopenapi/`).
+- Each implementation runs on different ports (`8000` and `8001` by default).
+
+### ▶️ Running the Benchmark
+1. Start both API implementations:
+   ```sh
+   python benchmarks/<framework>/without_fastopenapi/run.py
+   python benchmarks/<framework>/with_fastopenapi/run.py
+   ```
+2. Run the benchmark:
+   ```sh
+   python benchmarks/benchmark.py
+   ```
+3. Waiting for the results (example):
+   ```sh
+    Testing Original Implementation
+    
+    Original - Running 10000 iterations per endpoint
+    --------------------------------------------------
+    GET all records: 16.3760 sec total, 1.64 ms per request
+    GET one record: 17.7782 sec total, 1.78 ms per request
+    POST new record: 19.8376 sec total, 1.98 ms per request
+    PUT record: 20.4346 sec total, 2.04 ms per request
+    PATCH record: 19.7331 sec total, 1.97 ms per request
+    DELETE record: 37.4556 sec total, 3.75 ms per request
+    
+    Testing FastOpenAPI Implementation
+    
+    FastOpenAPI - Running 10000 iterations per endpoint
+    --------------------------------------------------
+    GET all records: 17.4752 sec total, 1.75 ms per request
+    GET one record: 18.3059 sec total, 1.83 ms per request
+    POST new record: 19.9647 sec total, 2.00 ms per request
+    PUT record: 19.3761 sec total, 1.94 ms per request
+    PATCH record: 19.5880 sec total, 1.96 ms per request
+    DELETE record: 40.6837 sec total, 4.07 ms per request
+    
+    Performance Comparison (10000 iterations)
+    ======================================================================
+    Endpoint                  Original        FastOpenAPI     Difference     
+    ----------------------------------------------------------------------
+    GET all records           1.64 ms         1.75 ms         0.11 ms (+6.7%)
+    GET one record            1.78 ms         1.83 ms         0.05 ms (+3.0%)
+    POST new record           1.98 ms         2.00 ms         0.01 ms (+0.6%)
+    PUT record                2.04 ms         1.94 ms         -0.11 ms (-5.2%)
+    PATCH record              1.97 ms         1.96 ms         -0.01 ms (-0.7%)
+    DELETE record             3.75 ms         4.07 ms         0.32 ms (+8.6%)
+   ```