rename:lindoc->api

Author: sunlin92

app/api/__init__.py

@@ -9,15 +9,15 @@
 
 if os.getenv("FLASK_ENV", "production") == "production":
     # spectree 暂未提供关闭文档功能，production部署变更随机路径
-    lindoc = SpecTree(
+    api = SpecTree(
         backend_name="flask",
         title="Lin-CMS API",
         mode="strict",
         version="0.3.0a6",
         path="/".join(str(uuid4()).split("-")),
     )
 else:
-    lindoc = SpecTree(
+    api = SpecTree(
         backend_name="flask",
         title="Lin-CMS API",
         mode="strict",

app/api/cms/log.py

@@ -8,7 +8,7 @@
 from lin.redprint import Redprint
 from sqlalchemy import text
 
-from app.api import lindoc
+from app.api import api
 from app.validator.schema import (
     AuthorizationSchema,
     LogPageSchema,
@@ -23,7 +23,7 @@
 @log_api.route("/search")
 @permission_meta(auth="查询日志", module="日志")
 @group_required
-@lindoc.validate(
+@api.validate(
     headers=AuthorizationSchema,
     query=LogQuerySearchSchema,
     resp=DocResponse(r=LogPageSchema),
@@ -57,7 +57,7 @@ def get_logs():
 @log_api.route("/users", methods=["GET"])
 @permission_meta(auth="查询日志记录的用户", module="日志")
 @group_required
-@lindoc.validate(
+@api.validate(
     headers=AuthorizationSchema,
     resp=DocResponse(r=StringList),
     tags=["日志"],

app/api/v1/book.py

@@ -11,7 +11,7 @@
 from lin.jwt import group_required, login_required
 from lin.redprint import Redprint
 
-from app.api import lindoc
+from app.api import api
 from app.exception.api import BookNotFound
 from app.model.v1.book import Book
 from app.validator.schema import (
@@ -25,7 +25,7 @@
 
 
 @book_api.route("/<int:id>", methods=["GET"])
-@lindoc.validate(
+@api.validate(
     resp=DocResponse(BookNotFound, r=BookSchema),
     tags=["图书"],
 )
@@ -40,7 +40,7 @@ def get_book(id: int):
 
 
 @book_api.route("", methods=["GET"])
-@lindoc.validate(
+@api.validate(
     resp=DocResponse(r=BookSchemaList),
     tags=["图书"],
 )
@@ -53,7 +53,7 @@ def get_books():
 
 
 @book_api.route("/search", methods=["GET"])
-@lindoc.validate(
+@api.validate(
     query=BookQuerySearchSchema,
     resp=DocResponse(BookNotFound, r=BookSchemaList),
     tags=["图书"],
@@ -72,7 +72,7 @@ def search():
 
 @book_api.route("", methods=["POST"])
 @login_required
-@lindoc.validate(
+@api.validate(
     headers=AuthorizationSchema,
     json=BookSchema,
     resp=DocResponse(Success(12)),
@@ -89,7 +89,7 @@ def create_book():
 
 @book_api.route("/<int:id>", methods=["PUT"])
 @login_required
-@lindoc.validate(
+@api.validate(
     headers=AuthorizationSchema,
     json=BookSchema,
     resp=DocResponse(Success(13)),
@@ -114,7 +114,7 @@ def update_book(id: int):
 @book_api.route("/<int:id>", methods=["DELETE"])
 @permission_meta(auth="删除图书", module="图书")
 @group_required
-@lindoc.validate(
+@api.validate(
     headers=AuthorizationSchema,
     resp=DocResponse(BookNotFound, Success(14)),
     tags=["图书"],

app/app.py

@@ -15,10 +15,10 @@ def register_blueprints(app):
     app.register_blueprint(create_cms(), url_prefix="/cms")
 
 
-def register_lindoc(app):
-    from app.api import lindoc
+def register_api(app):
+    from app.api import api
 
-    lindoc.register(app)
+    api.register(app)
 
 
 def apply_cors(app):
@@ -60,7 +60,7 @@ def create_app(register_all=True, **kwargs):
 
         set_global_config(**kwargs)
         register_blueprints(app)
-        register_lindoc(app)
+        register_api(app)
         apply_cors(app)
         Lin(app, **kwargs)
     return app