在命名空間實例化 flask_restx 上添加 doc 裝飾器

Question

我正在嘗試將 OpenAPI/Swagger 文檔添加到 flask_restx 命名空間 class。

添加文檔的記錄方法是通過在資源 class: @ns.doc(description="my documentation")上添加文檔裝飾器來完成的。

在命名空間 class 中有一個裝飾器參數，它采用裝飾器列表並將它們應用於每個資源（然后在 Api 類中調用它們）。

我不知道如何將@ns.doc裝飾器列表添加到命名空間

from flask_restx import Namespace, Resource

ns = Namespace(name = "namespace name")

ns.decorators = [
  simple_decorator_works,
  ns_doc_decorator(description="My default documentation on each resource")
]

@ns.route("/")
class MyResource(Resource):
    def get(self):
      return "awesome"

ns_doc_decorator應該可以接收一些默認參數

Answer 1

需要一個基礎資源 class 並且裝飾器放置在該基礎資源 class 上。

@ns.doc(description="My default documentation on each resource" etc)
class BaseResource(Resource): 
    ...
       
resource = type("resourceName", (BaseResource,), {'get': get_method, 'post': post_method etc})

ns.add_resource(resource)