WebAPIを設計するときに考えること - なみひらブログ

背景WebAPIを設計してきて、最近ある程度考え方・注意点がまとまってきたので整理も兼ねてメモっときます。 観点 同じ事柄を表すリソース構造には一貫性があること例えば「人」を表す際に、叩くAPIによってリソース構造を変えてはいけない（単体での情報取得APIと一覧取得のAPI、検索APIなど）。クライアント*1が扱うリソース構造を共通化させてあげる。 それを実現するには、WebAPI（HTTPメソッドとかパス）を考える前にリソース自体の構造をまず整理したほうがよい。 リソースには何かしらの標準があったりするので参考にできるならしたほうがいい。IANA — Protocol Registriesなど。 例："人リソース"で構造が違うダメな例 叩くAPIによって { "id" : 123, "name" : "なみひら" } と { "id" : "123", "familyName" : "な