官方原文链接

元数据

REST framework 包含一个可配置的机制，用于确定 API 如何响应 OPTIONS 请求。这使你可以返回 API schema 或其他资源信息。

对于 HTTP OPTIONS 请求应该返回哪种风格的响应，目前还没有任何被广泛采用的约定，所以我们提供了一种专门的风格来返回一些有用的信息。

下面是一个示例响应，演示默认返回的信息。

  1. HTTP 200 OK
  2. Allow: GET, POST, HEAD, OPTIONS
  3. Content-Type: application/json
  5. {
  6.     "name": "To Do List",
  7.     "description": "List existing 'To Do' items, or create a new item.",
  8.     "renders": [
  9.         "application/json",
  10.         "text/html"
  11.     ],
  12.     "parses": [
  13.         "application/json",
  14.         "application/x-www-form-urlencoded",
  15.         "multipart/form-data"
  16.     ],
  17.     "actions": {
  18.         "POST": {
  19.             "note": {
  20.                 "type": "string",
  21.                 "required": false,
  22.                 "read_only": false,
  23.                 "label": "title",
  24.                 "max_length": 100
  25.             }
  26.         }
  27.     }
  28. }

设置元数据 scheme

你可以使用 'DEFAULT_METADATA_CLASS' settings key 全局设置元数据类：

  1. REST_FRAMEWORK = {
  2.     'DEFAULT_METADATA_CLASS': 'rest_framework.metadata.SimpleMetadata'
  3. }

或者你可以单独设置一个视图的元数据类：

  1. class APIRoot(APIView):
  2.     metadata_class = APIRootMetadata
  4.     def get(self, request, format=None):
  5.         return Response({
  6.             ...
  7.         })

REST framework 包只包含一个名为 SimpleMetadata 的元数据类实现。如果你想使用另一种风格，你需要实现一个自定义的元数据类。

创建 schema 端点

如果你对创建通过常规 GET 请求访问的 schema 端点有特定要求，则可以考虑重新使用元数据 API 来实现此目的。

例如，可以在视图集上使用以下附加路由来提供可链接的 schema 端点。

  1. @list_route(methods=['GET'])
  2. def schema(self, request):
  3.     meta = self.metadata_class()
  4.     data = meta.determine_metadata(request, self)
  5.     return Response(data)

有几个原因可以选择采用这种方法，包括 OPTIONS 响应不能缓存。

自定义元数据类

如果你想提供一个自定义的元数据类，你应该继承 BaseMetadata 并且实现 determine_metadata(self, request, view) 方法。

你可能想要做的事情包括返回 schema 信息，使用 JSON schema 等格式，或将调试信息返回给管理员用户。

举个栗子

以下类可用于限定返回到 OPTIONS 请求的信息。

  1. class MinimalMetadata(BaseMetadata):
  2.     """
  3.     Don't include field and other information for `OPTIONS` requests.
  4.     Just return the name and description.
  5.     """
  6.     def determine_metadata(self, request, view):
  7.         return {
  8.             'name': view.get_view_name(),
  9.             'description': view.get_view_description()
  10.         }

然后配置你的设置以使用此自定义类：

  1. REST_FRAMEWORK = {
  2.     'DEFAULT_METADATA_CLASS': 'myproject.apps.core.MinimalMetadata'
  3. }