feat:兼容swaager返回值为列表

Author: sunlin92

app/api/cms/log.py

@@ -11,9 +11,9 @@
 from app.api import lindoc
 from app.validator.schema import (
     AuthorizationSchema,
-    LogListSchema,
+    LogPageSchema,
     LogQuerySearchSchema,
-    NameListSchema,
+    StringList,
 )
 
 log_api = Redprint("log")
@@ -26,7 +26,7 @@
 @lindoc.validate(
     headers=AuthorizationSchema,
     query=LogQuerySearchSchema,
-    resp=DocResponse(http_200=LogListSchema),
+    resp=DocResponse(http_200=LogPageSchema),
     before=LogQuerySearchSchema.offset_handler,
     tags=["日志"],
 )
@@ -49,7 +49,7 @@ def get_logs():
     )
     total_page = math.ceil(total / g.count)
 
-    return LogListSchema(
+    return LogPageSchema(
         page=g.page, count=g.count, total=total, items=items, total_page=total_page
     )
 
@@ -59,7 +59,7 @@ def get_logs():
 @group_required
 @lindoc.validate(
     headers=AuthorizationSchema,
-    resp=DocResponse(http_200=NameListSchema),
+    resp=DocResponse(http_200=StringList),
     tags=["日志"],
 )
 def get_users_for_log():
@@ -73,4 +73,4 @@ def get_users_for_log():
         .having(text("count(username) > 0"))
         .all()
     )
-    return NameListSchema(items=[u.username for u in usernames])
+    return StringList.parse_obj([u.username for u in usernames])

app/api/v1/book.py

@@ -16,7 +16,7 @@
 from app.model.v1.book import Book
 from app.validator.schema import (
     AuthorizationSchema,
-    BookListSchema,
+    BookSchemaList,
     BookQuerySearchSchema,
     BookSchema,
 )
@@ -41,23 +41,21 @@ def get_book(id: int):
 
 @book_api.route("", methods=["GET"])
 @lindoc.validate(
-    resp=DocResponse(http_200=BookListSchema),
+    resp=DocResponse(http_200=BookSchemaList),
     tags=["图书"],
 )
 def get_books():
     """
     获取图书列表
     """
     books = Book.get(one=False)
-    # TODO JSON
-    # return BookListSchema(items=books)
-    return books
+    return BookSchemaList.parse_obj(books)
 
 
 @book_api.route("/search", methods=["GET"])
 @lindoc.validate(
     query=BookQuerySearchSchema,
-    resp=DocResponse(BookNotFound, http_200=BookListSchema),
+    resp=DocResponse(BookNotFound, http_200=BookSchemaList),
     tags=["图书"],
 )
 def search():
@@ -68,10 +66,8 @@ def search():
         Book.title.like("%" + g.q + "%"), Book.delete_time == None
     ).all()
     if books:
-        return books
+        return BookSchemaList.parse_obj(books)
     raise BookNotFound
-    # TODO JSON
-    # return BookListSchema(items=books)
 
 
 @book_api.route("", methods=["POST"])

app/validator/schema.py

@@ -16,11 +16,11 @@ class AuthorizationSchema(BaseModel):
 
 
 class BookQuerySearchSchema(BaseModel):
-    q: Optional[str] = None
+    q: Optional[str] = str()
 
 
-class NameListSchema(BaseModel):
-    items: List[str] = list()
+class StringList(BaseModel):
+    __root__: List[str]
 
 
 class LogQuerySearchSchema(BaseModel):
@@ -53,15 +53,15 @@ class LogSchema(BaseModel):
     permission: str
 
 
-class BaseListSchema(BaseModel):
+class BasePageSchema(BaseModel):
     page: int
     count: int
     total: int
     total_page: int
     items: List[Any]
 
 
-class LogListSchema(BaseListSchema):
+class LogPageSchema(BasePageSchema):
     items: List[LogSchema]
 
 
@@ -72,8 +72,8 @@ class BookSchema(BaseModel):
     summary: str
 
 
-class BookListSchema(BaseModel):
-    items: List[BookSchema]
+class BookSchemaList(BaseModel):
+    __root__: List[BookSchema]
 
 
 class Language(str, Enum):