Open1
パス設計
- RESTの場合、リソースを表すものとして使用する
- 基本的に名詞を使用する
- api/companies/
- 集合の中にある個々のリソースを表す場合は、集合のリソースのパスに続けて識別する値を含める
- api/companies/{id}
- 親リソースを子リソースのパスに含めるかは、ケースバイケース
- api/companies/{id}/persons/{id}
- api/persons/{id}
- 個別の属性としてリソースを表すか、属性をグループ化して構造化された形で表すかは、ケースバイケース
- api/companies/address
- api/companies/phone
- api/companies/email
- or
- api/companies/contacts/address
- api/companies/contacts/phone
- api/companies/contacts/email
- リソースで表すのが困難な場合、動詞を使用して操作を表すパスとすることもあるが、安易には使用しない
- api/signup