0

私は JSON API を構築しており、userリソースを持っています。Auserにはid、プライマリ識別子とその他のいくつかのフィールドがあります:facebook_idなどlinkedin_id。

特定のフィールドが存在するかどうかを確認する必要がありますuserが、他のフィールドの 1 つ (例: facebook_id) を使用するだけです。プライマリ識別子がないため/users/<id>、それが a を返すかどうかを使用して確認することはできません。404

を使用することを考えました/users/exists?<field>=<value>が、これが JSON API で正しいアプローチであるかどうかはわかりません。

私の質問は、どのエンドポイントを作成する必要があるか、ドキュメントが存在するかどうかに応じてどのコードを返す必要があるか、そしてどのような本文ですか?

4

1 に答える 1

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'
于 2015-09-29T23:13:17.237 に答える