api - 搜索文档是否存在于 JSON API 中，而不是按主要标识符

Question

我正在构建一个 JSON API 并拥有一个user资源。Auser有id它的主要标识符和其他一些字段：facebook_id，linkedin_id等等。

我需要检查某个是否user存在，仅通过拥有其他字段之一（例如：）facebook_id。我无法使用/users/<id>并检查它是否返回 a404因为我没有主标识符。

我考虑过使用/users/exists?<field>=<value>，但我不确定这是否是 JSON API 的正确方法。

我的问题是，我应该创建什么端点，如果文档存在或不存在，它应该返回什么代码，以及什么正文？

Answer 1

您可以使用 facebook id 作为查询字符串中的参数，例如：

GET /users?facebookId=12345

如果 http 状态码响应为 200 则用户确实存在并且内容是用户资源，例如：

/users?facebookId={fb_id}:
    get:
      summary: ...
      description: ...
      parameters:
        - name: fb_id
          in: path
          required: true
          type: integer
      responses:
        "200":
          description: ...
          schema: 
            $ref: '#/definitions/userResource'