rest - API ブループリント スキーマの使用

Question

API ブループリントをスキーマと一緒に使用したいと考えています。たとえば、リソースへの PUT がペイロードでアカウントを受け入れ、同じリソースの GET がアカウント ペイロードを返すように指定したいとします。そのため、アカウントが GET および PUT で使用されることを指定する必要があり、アカウント自体を指定する必要があります。どこで指定すればいいのかわからないのですが、標準的な方法は何ですか? 残念ながら、私は例でそれを見つけることができませんでした.

Answer 1

複数のアクションで 1 つのメッセージ ペイロードを再利用することは、リソース モデルの概念を利用できる場所です。

アカウント モデルを定義し、後で次のように再利用するだけです。

# Account [/account]

+ Model (application/json)
    + Body

            { ... }

    + Schema

            { ... }

## Retrieve an Account [GET]

+ Response 200

    [Account][]


## Update an Account [PUT]

+ Request

    [Account][]

+ Response 204