Added standard error responses. Added response_errors for routers.

Author: mr-fatalyst

CHANGELOG.md

@@ -9,6 +9,8 @@ FastOpenAPI follows the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Added
 - `AioHttpRouter` for integration with the `AioHttp` framework
 - Class-level cache for model schemas
+- `response_errors` for routers
+- `error_handler` for standard error responses
 
 ## [0.4.0] - 2025-03-20
 

examples/aiohttp/app/api/v1/authors.py

@@ -15,32 +15,58 @@
 router = AioHttpRouter()
 
 
-@router.post("/authors", tags=["Authors"], status_code=201, response_model=AuthorSchema)
+@router.post(
+    "/authors",
+    tags=["Authors"],
+    status_code=201,
+    response_errors=[400, 422, 500],
+    response_model=AuthorSchema,
+)
 async def create_author(body: CreateAuthorSchema) -> AuthorSchema:
     return await author_service.create_author(body)
 
 
-@router.get("/authors/{author_id}", tags=["Authors"], response_model=AuthorSchema)
+@router.get(
+    "/authors/{author_id}",
+    tags=["Authors"],
+    response_errors=[400, 404, 500],
+    response_model=AuthorSchema,
+)
 async def get_author(author_id: int) -> AuthorSchema:
     author = await author_service.get_author(author_id)
     if not author:
         raise web.HTTPNotFound(reason="Author not found")
     return author
 
 
-@router.get("/authors/", tags=["Authors"], response_model=list[AuthorSchema])
+@router.get(
+    "/authors/",
+    tags=["Authors"],
+    response_errors=[500],
+    response_model=list[AuthorSchema],
+)
 async def get_authors(body: FilterAuthorSchema) -> list[AuthorSchema]:
     return await author_service.get_authors(body)
 
 
-@router.delete("/authors/{author_id}", tags=["Authors"], status_code=204)
+@router.delete(
+    "/authors/{author_id}",
+    tags=["Authors"],
+    status_code=204,
+    response_errors=[400, 404, 500],
+)
 async def delete_author(author_id: int) -> None:
     author = await author_service.delete_author(author_id)
     if not author:
         raise web.HTTPNotFound(reason="Author not found")
 
 
-@router.patch("/authors/{author_id}", tags=["Authors"], response_model=AuthorSchema)
+@router.patch(
+    "/authors/{author_id}",
+    tags=["Authors"],
+    response_errors=[400, 404, 422, 500],
+    response_model=AuthorSchema,
+)
 async def update_author(author_id: int, body: UpdateAuthorSchema) -> AuthorSchema:
     author = await author_service.update_author(author_id, body)
     if not author:

examples/aiohttp/app/api/v1/posts.py

@@ -14,32 +14,52 @@
 router = AioHttpRouter()
 
 
-@router.post("/posts", tags=["Posts"], status_code=201, response_model=PostSchema)
+@router.post(
+    "/posts",
+    tags=["Posts"],
+    status_code=201,
+    response_errors=[400, 422, 500],
+    response_model=PostSchema,
+)
 async def create_post(body: CreatePostSchema) -> PostSchema:
     return await post_service.create_post(body)
 
 
-@router.get("/posts/{post_id}", tags=["Posts"], response_model=PostSchema)
+@router.get(
+    "/posts/{post_id}",
+    tags=["Posts"],
+    response_errors=[400, 404, 500],
+    response_model=PostSchema,
+)
 async def get_post(post_id: int) -> PostSchema:
     post = await post_service.get_post(post_id)
     if not post:
         raise web.HTTPNotFound(reason="Author not found")
     return post
 
 
-@router.get("/posts/", tags=["Posts"], response_model=list[PostSchema])
+@router.get(
+    "/posts/", tags=["Posts"], response_errors=[500], response_model=list[PostSchema]
+)
 async def get_posts(body: FilterPostSchema) -> list[PostSchema]:
     return await post_service.get_posts(body)
 
 
-@router.delete("/posts/{post_id}", tags=["Posts"], status_code=204)
+@router.delete(
+    "/posts/{post_id}", tags=["Posts"], status_code=204, response_errors=[400, 404, 500]
+)
 async def delete_post(post_id: int) -> None:
     post = await post_service.delete_post(post_id)
     if not post:
         raise web.HTTPNotFound(reason="Post not found")
 
 
-@router.patch("/posts/{post_id}", tags=["Posts"], response_model=PostSchema)
+@router.patch(
+    "/posts/{post_id}",
+    tags=["Posts"],
+    response_errors=[400, 404, 422, 500],
+    response_model=PostSchema,
+)
 async def update_post(post_id: int, body: UpdatePostSchema) -> PostSchema:
     post = await post_service.update_post(post_id, body)
     if not post:

examples/falcon/app/api/v1/authors.py

@@ -15,32 +15,58 @@
 router = FalconRouter()
 
 
-@router.post("/authors", tags=["Authors"], status_code=201, response_model=AuthorSchema)
+@router.post(
+    "/authors",
+    tags=["Authors"],
+    status_code=201,
+    response_errors=[400, 422, 500],
+    response_model=AuthorSchema,
+)
 async def create_author(body: CreateAuthorSchema) -> AuthorSchema:
     return await author_service.create_author(body)
 
 
-@router.get("/authors/{author_id}", tags=["Authors"], response_model=AuthorSchema)
+@router.get(
+    "/authors/{author_id}",
+    tags=["Authors"],
+    response_errors=[400, 404, 500],
+    response_model=AuthorSchema,
+)
 async def get_author(author_id: int) -> AuthorSchema:
     author = await author_service.get_author(author_id)
     if not author:
         raise falcon.HTTPNotFound()
     return author
 
 
-@router.get("/authors/", tags=["Authors"], response_model=list[AuthorSchema])
+@router.get(
+    "/authors/",
+    tags=["Authors"],
+    response_errors=[500],
+    response_model=list[AuthorSchema],
+)
 async def get_authors(body: FilterAuthorSchema) -> list[AuthorSchema]:
     return await author_service.get_authors(body)
 
 
-@router.delete("/authors/{author_id}", tags=["Authors"], status_code=204)
+@router.delete(
+    "/authors/{author_id}",
+    tags=["Authors"],
+    status_code=204,
+    response_errors=[400, 404, 500],
+)
 async def delete_author(author_id: int) -> None:
     author = await author_service.delete_author(author_id)
     if not author:
         raise falcon.HTTPNotFound()
 
 
-@router.patch("/authors/{author_id}", tags=["Authors"], response_model=AuthorSchema)
+@router.patch(
+    "/authors/{author_id}",
+    tags=["Authors"],
+    response_errors=[400, 404, 422, 500],
+    response_model=AuthorSchema,
+)
 async def update_author(author_id: int, body: UpdateAuthorSchema) -> AuthorSchema:
     author = await author_service.update_author(author_id, body)
     if not author:

examples/falcon/app/api/v1/posts.py

@@ -14,32 +14,52 @@
 router = FalconRouter()
 
 
-@router.post("/posts", tags=["Posts"], status_code=201, response_model=PostSchema)
+@router.post(
+    "/posts",
+    tags=["Posts"],
+    status_code=201,
+    response_errors=[400, 422, 500],
+    response_model=PostSchema,
+)
 async def create_post(body: CreatePostSchema) -> PostSchema:
     return await post_service.create_post(body)
 
 
-@router.get("/posts/{post_id}", tags=["Posts"], response_model=PostSchema)
+@router.get(
+    "/posts/{post_id}",
+    tags=["Posts"],
+    response_errors=[400, 404, 500],
+    response_model=PostSchema,
+)
 async def get_post(post_id: int) -> PostSchema:
     post = await post_service.get_post(post_id)
     if not post:
         raise falcon.HTTPNotFound()
     return post
 
 
-@router.get("/posts/", tags=["Posts"], response_model=list[PostSchema])
+@router.get(
+    "/posts/", tags=["Posts"], response_errors=[500], response_model=list[PostSchema]
+)
 async def get_posts(body: FilterPostSchema) -> list[PostSchema]:
     return await post_service.get_posts(body)
 
 
-@router.delete("/posts/{post_id}", tags=["Posts"], status_code=204)
+@router.delete(
+    "/posts/{post_id}", tags=["Posts"], status_code=204, response_errors=[400, 404, 500]
+)
 async def delete_post(post_id: int) -> None:
     post = await post_service.delete_post(post_id)
     if not post:
         raise falcon.HTTPNotFound()
 
 
-@router.patch("/posts/{post_id}", tags=["Posts"], response_model=PostSchema)
+@router.patch(
+    "/posts/{post_id}",
+    tags=["Posts"],
+    response_errors=[400, 404, 422, 500],
+    response_model=PostSchema,
+)
 async def update_post(post_id: int, body: UpdatePostSchema) -> PostSchema:
     post = await post_service.update_post(post_id, body)
     if not post:

examples/flask/app/api/v1/authors.py

@@ -17,33 +17,59 @@
 router = FlaskRouter()
 
 
-@router.post("/authors", tags=["Authors"], status_code=201, response_model=AuthorSchema)
+@router.post(
+    "/authors",
+    tags=["Authors"],
+    status_code=201,
+    response_errors=[400, 422, 500],
+    response_model=AuthorSchema,
+)
 def create_author(body: CreateAuthorSchema) -> AuthorSchema:
     return author_service.create_author(body)
 
 
-@router.get("/authors/{author_id}", tags=["Authors"], response_model=AuthorSchema)
+@router.get(
+    "/authors/{author_id}",
+    tags=["Authors"],
+    response_errors=[400, 404, 500],
+    response_model=AuthorSchema,
+)
 def get_author(author_id: int) -> AuthorSchema:
     author = author_service.get_author(author_id)
     if not author:
         abort(HTTPStatus.NOT_FOUND)
     return author
 
 
-@router.get("/authors/", tags=["Authors"], response_model=list[AuthorSchema])
+@router.get(
+    "/authors/",
+    tags=["Authors"],
+    response_errors=[500],
+    response_model=list[AuthorSchema],
+)
 def get_authors(body: FilterAuthorSchema) -> list[AuthorSchema]:
     return author_service.get_authors(body)
 
 
-@router.delete("/authors/{author_id}", tags=["Authors"], status_code=204)
+@router.delete(
+    "/authors/{author_id}",
+    tags=["Authors"],
+    status_code=204,
+    response_errors=[400, 404, 500],
+)
 def delete_author(author_id: int) -> None:
     author = author_service.delete_author(author_id)
     if not author:
         abort(HTTPStatus.NOT_FOUND)
     return None
 
 
-@router.patch("/authors/{author_id}", tags=["Authors"], response_model=AuthorSchema)
+@router.patch(
+    "/authors/{author_id}",
+    tags=["Authors"],
+    response_errors=[400, 404, 422, 500],
+    response_model=AuthorSchema,
+)
 def update_author(author_id: int, body: UpdateAuthorSchema) -> AuthorSchema:
     author = author_service.update_author(author_id, body)
     if not author:

examples/flask/app/api/v1/posts.py

@@ -16,32 +16,52 @@
 router = FlaskRouter()
 
 
-@router.post("/posts", tags=["Posts"], status_code=201, response_model=PostSchema)
+@router.post(
+    "/posts",
+    tags=["Posts"],
+    status_code=201,
+    response_errors=[400, 422, 500],
+    response_model=PostSchema,
+)
 def create_post(body: CreatePostSchema) -> PostSchema:
     return post_service.create_post(body)
 
 
-@router.get("/posts/{post_id}", tags=["Posts"], response_model=PostSchema)
+@router.get(
+    "/posts/{post_id}",
+    tags=["Posts"],
+    response_errors=[400, 404, 500],
+    response_model=PostSchema,
+)
 def get_post(post_id: int) -> PostSchema:
     post = post_service.get_post(post_id)
     if not post:
         abort(HTTPStatus.NOT_FOUND)
     return post
 
 
-@router.get("/posts/", tags=["Posts"], response_model=list[PostSchema])
+@router.get(
+    "/posts/", tags=["Posts"], response_errors=[500], response_model=list[PostSchema]
+)
 def get_posts(body: FilterPostSchema) -> list[PostSchema]:
     return post_service.get_posts(body)
 
 
-@router.delete("/posts/{post_id}", tags=["Posts"], status_code=204)
+@router.delete(
+    "/posts/{post_id}", tags=["Posts"], status_code=204, response_errors=[400, 404, 500]
+)
 def delete_post(post_id: int) -> None:
     post = post_service.delete_post(post_id)
     if not post:
         abort(HTTPStatus.NOT_FOUND)
 
 
-@router.patch("/posts/{post_id}", tags=["Posts"], response_model=PostSchema)
+@router.patch(
+    "/posts/{post_id}",
+    tags=["Posts"],
+    response_errors=[400, 404, 422, 500],
+    response_model=PostSchema,
+)
 def update_post(post_id: int, body: UpdatePostSchema) -> PostSchema:
     post = post_service.update_post(post_id, body)
     if not post: