php swagger OAT\Schema property の整理

ああ～～これを何度も何度も忘れて、また忘れてしまうので…… いっそブログに書いておいて、検索したほうが早いと思い、書いておく。 ## Swagger OAT\Schema Property リスト ### リクエストの記述 (#\[OAT\Property]) #### type が array で、Laravel Data の値を入れる場合 ```php #[OAT\Property(property: 'productOptions', type: 'array', items: new OAT\Items(ref: '#/components/schemas/OptionData', type: 'object'))] ``` #### type が array で、値を設定しない場合 ```php #[OAT\Property(property: 'features', type: 'array', items: new OAT\Items())] ``` #### type が array で、Enum の値を入れる場合 ```php #[OAT\Property(property: 'meta', type: 'array', items: new OAT\Items(ref: '#/components/schemas/MetaEnum'))] ``` #### type が object で、Laravel Data の値を入れる場合 ```php #[OAT\Property(property: 'link', ref: '#/components/schemas/LinkData', type: 'object')] ``` #### type が enum で、単一選択にする場合 ```php #[OAT\Property(property: 'state', ref: '#/components/schemas/State', type: 'enum')] ``` #### type を date-time にする場合 ```php #[OAT\Property(property: 'start_at', type: 'string', format: 'date-time')] ``` ### Controller の記述 #### array resource の場合 ```php new OAT\Property(property: 'data', type: 'array', items: new OAT\Items(ref: '#/components/schemas/UserResource')), ``` #### response の data に object を入れる場合 ```php new OAT\Property(property: 'data', ref: '#/components/schemas/GroupResource', type: 'object'), ```

php swagger OAT\Schema property の整理

ほかの記事

Swagger OAT\Schema Property リスト#

リクエストの記述 (#[OAT\Property])#

type が array で、Laravel Data の値を入れる場合#

type が array で、値を設定しない場合#

type が array で、Enum の値を入れる場合#

type が object で、Laravel Data の値を入れる場合#

type が enum で、単一選択にする場合#

type を date-time にする場合#

Controller の記述#

array resource の場合#

response の data に object を入れる場合#