{"id":89,"date":"2018-02-08T13:35:06","date_gmt":"2018-02-08T04:35:06","guid":{"rendered":"https:\/\/wp.apibank.jp\/contents\/?p=89"},"modified":"2020-11-05T13:36:34","modified_gmt":"2020-11-05T04:36:34","slug":"what-matters-to-api-design","status":"publish","type":"post","link":"https:\/\/www.apibank.jp\/contents\/news\/what-matters-to-api-design\/","title":{"rendered":"\u4f7f\u3044\u52dd\u624b\u3084\u62e1\u5f35\u6027\u3092\u62c5\u4fdd\u3067\u304d\u308bAPI\u8a2d\u8a08\u306b\u306f\u3001\u8a2d\u8a08\u6642\u306e\u30eb\u30fc\u30eb\u4f5c\u6210\u304c\u4e0d\u53ef\u6b20"},"content":{"rendered":"\n

API\u306e\u8a2d\u8a08\u306b\u304a\u3044\u3066\u3001\u958b\u767a\u8005\u306b\u3068\u3063\u3066\u306e\u4f7f\u3044\u52dd\u624b\u3084\u3001\u63d0\u4f9b\u8005\u306e\u30e1\u30f3\u30c6\u30ca\u30f3\u30b9\u30fb\u62e1\u5f35\u306e\u3057\u3084\u3059\u3055\u306b\u914d\u616e\u3059\u308b\u3053\u3068\u306f\u3068\u3066\u3082\u91cd\u8981\u3067\u3059\u3002
\u8a18\u4e8b\u3067\u306f\u3001\u7dba\u9e97\u306aAPI\u3092\u8a2d\u8a08\u3059\u308b\u305f\u3081\u306b\u914d\u616e\u3057\u3066\u304a\u304f\u3079\u304d\uff15\u3064\u306e\u30eb\u30fc\u30eb\u304c\u7d39\u4ecb\u3055\u308c\u3066\u3044\u307e\u3059\u3002<\/p>\n\n\n\n

1. \u30e2\u30c7\u30eb\u578b\u304b\u30a2\u30af\u30b7\u30e7\u30f3\u578b\u304b<\/h3>\n\n\n\n

REST API\u306eURL\u3092\u8a2d\u8a08\u3059\u308b\u969b\u3001\u300c\u30e6\u30fc\u30b6\u30fc\u300d\u3084\u300c\u5546\u54c1\u300d\u3092\u8ef8\u306b\u3057\u305f\u30e2\u30c7\u30eb\u578b\u3092\u63a1\u7528\u3059\u308b\u5834\u5408\u3068\u3001\u300c\u8cfc\u5165\u3059\u308b\u300d\u300c\u51fa\u5e2d\u3059\u308b\u300d\u306a\u3069\u306e\u884c\u52d5\u3092\u8ef8\u306b\u3057\u305f\u30a2\u30af\u30b7\u30e7\u30f3\u578b\u3092\u63a1\u7528\u3059\u308b\u5834\u5408\u304c\u3042\u308a\u307e\u3059\u3002<\/p>\n\n\n\n

\u3053\u306e\u969b\u3001\u4e21\u65b9\u3092\u53d6\u308a\u5165\u308c\u308b\u3068\u5206\u304b\u308a\u3065\u3089\u3044URL\u3068\u306a\u3063\u3066\u3057\u307e\u3046\u61f8\u5ff5\u304c\u3042\u308b\u305f\u3081\u3001\u3069\u3061\u3089\u3092\u63a1\u7528\u3059\u308b\u306b\u3057\u3066\u3082\u660e\u78ba\u306a\u57fa\u6e96\u3092\u4f5c\u3063\u3066\u304a\u304f\u3068\u3088\u3044\u3067\u3057\u3087\u3046\u3002<\/p>\n\n\n\n

2. RESTful\u306e\u539f\u5247\u306b\u5f93\u3046<\/h3>\n\n\n\n

RESTful\u306e\u539f\u5247\u3068\u306f\u3001\u64cd\u4f5c\u3059\u308b\u5bfe\u8c61\u306e\u30ea\u30bd\u30fc\u30b9\u3092URL\u3067\u6307\u5b9a\u3057\u3001CRUD\u64cd\u4f5c\u3092HTTP\u30e1\u30bd\u30c3\u30c9\u3067\u6307\u5b9a\u3059\u308b\u3068\u3044\u3046\u3082\u306e\u3067\u3059\u3002<\/p>\n\n\n\n

\u305f\u3068\u3048\u3070\u3072\u3068\u3064\u306e\u30ea\u30bd\u30fc\u30b9\u304c\u8907\u6570\u306e\u72b6\u614b\u3092\u3082\u3064\u5834\u5408\u306a\u3069\u7ba1\u7406\u304c\u7169\u96d1\u306b\u306a\u3063\u3066\u3057\u307e\u3046\u969b\u306b\u306f\u3001\u30b3\u30f3\u30c8\u30ed\u30fc\u30e9\u306e\u6a5f\u80fd\u3092\u5206\u96e2\u3059\u308b\u8003\u3048\u65b9\u304c\u3042\u308a\u307e\u3059\u3002\u30b3\u30fc\u30c9\u3092\u77ed\u7e2e\u3067\u304d\u307e\u3059\u3057\u3001\u64cd\u4f5c\u3059\u308b\u5bfe\u8c61\u306e\u30ea\u30bd\u30fc\u30b9\u3092URL\u3067\u6307\u5b9a\u3001HTTP\u30e1\u30bd\u30c3\u30c9\u3067\u64cd\u4f5c\u3068\u3044\u3046RESTful\u306e\u539f\u5247\u304c\u7dad\u6301\u3067\u304d\u307e\u3059\u3002<\/p>\n\n\n\n

3. \u30d0\u30fc\u30b8\u30e7\u30f3\u3092URI\u306b\u6301\u305f\u305b\u306a\u3044<\/h3>\n\n\n\n

API\u306e\u30d0\u30fc\u30b8\u30e7\u30f3\u3092URI\u306b\u5165\u308c\u308b\u5834\u5408\u3001\u30d0\u30fc\u30b8\u30e7\u30f3\u30a2\u30c3\u30d7\u3057\u305f\u969b\u306b\u65e7\u30d0\u30fc\u30b8\u30e7\u30f3\u3067\u52d5\u4f5c\u3059\u308b\u30e9\u30a4\u30d6\u30e9\u30ea\u3092\u30b3\u30d4\u30fc\u3059\u308b\u5fc5\u8981\u304c\u51fa\u3066\u304d\u307e\u3059\u3002<\/p>\n\n\n\n

\u305d\u3053\u3067\u3001HTTP\u30d8\u30c3\u30c0\u30fc\u3084\u30af\u30a8\u30ea\u30b9\u30c8\u30ea\u30f3\u30b0\u306e\u4e2d\u306b\u30d0\u30fc\u30b8\u30e7\u30f3\u756a\u53f7\u3092\u6301\u305f\u305b\u308b\u3068\u3044\u3046\u65b9\u6cd5\u304c\u3042\u308a\u307e\u3059\u3002\u3053\u306e\u65b9\u6cd5\u3067\u3042\u308c\u3070\u540c\u3058\u3088\u3046\u306a\u30b3\u30fc\u30c9\u304c\u5897\u3048\u305a\u7ba1\u7406\u3082\u697d\u306b\u306a\u308a\u307e\u3059\u3002<\/p>\n\n\n\n

4. \u30ec\u30b9\u30dd\u30f3\u30b9\u306bHAL\u3084JSON API\u3092\u63a1\u7528\u3059\u308b<\/h3>\n\n\n\n

JSON\u3060\u3051\u3067\u306f\u60c5\u5831\u304c\u4e0d\u8db3\u3059\u308b\u5834\u5408\u306b\u306f\u3001\u300cHAL\u300d\u3084\u300cJSON API\u300d\u306a\u3069\u60c5\u5831\u3092\u4ed8\u4e0e\u3059\u308b\u30d5\u30a9\u30fc\u30de\u30c3\u30c8\u3092\u63a1\u7528\u3059\u308b\u65b9\u6cd5\u3082\u3042\u308a\u307e\u3059\u3002<\/p>\n\n\n\n

JSON API\u306fJSON\u306b\u60c5\u5831\u3092\u8ffd\u52a0\u3067\u304d\u3001HAL\u306f\u30da\u30fc\u30b8\u30cd\u30fc\u30b7\u30e7\u30f3\u304c\u3042\u308b\u6642\u306b\u6b21\u306e\u30ea\u30f3\u30af\u3092\u793a\u3059\u3053\u3068\u304c\u3067\u304d\u305f\u308a\u3001\u8ffd\u52a0\u306e\u30e1\u30bf\u30c7\u30fc\u30bf\u3092\u4ed8\u4e0e\u3067\u304d\u307e\u3059\u3002<\/p>\n\n\n\n

\u305f\u3060\u3057API\u306e\u30ec\u30b9\u30dd\u30f3\u30b9\u5909\u66f4\u306f\u7c21\u5358\u3067\u306f\u306a\u3044\u305f\u3081\u3001\u3053\u308c\u304b\u3089\u4f5c\u308bAPI\u3067\u306e\u63a1\u7528\u3092\u6c7a\u3081\u3066\u3082\u3088\u3044\u3067\u3057\u3087\u3046\u3002<\/p>\n\n\n\n

5. POST\/PUT\u3067\u3082\u30ec\u30b9\u30dd\u30f3\u30b9\u30dc\u30c7\u30a3\u3092\u8fd4\u3059<\/h3>\n\n\n\n

2\u56deAPI\u306b\u30a2\u30af\u30bb\u30b9\u3059\u308b\u5fc5\u8981\u304c\u3042\u308b\u3068\u30cd\u30c3\u30c8\u30ef\u30fc\u30af\u306b\u8ca0\u8377\u304c\u304b\u304b\u308a\u307e\u3059\u3002<\/p>\n\n\n\n

POST\u3084PUT\u3067\u66f4\u65b0\u3057\u305f\u6700\u65b0\u306e\u72b6\u614b\u306e\u30c7\u30fc\u30bf\u3092\u30ec\u30b9\u30dd\u30f3\u30b9\u306b\u542b\u3081\u308b\u3088\u3046\u306b\u3059\u308b\u3053\u3068\u3067\u3001\u30af\u30e9\u30a4\u30a2\u30f3\u30c8\u304b\u3089\u306e\u30ea\u30af\u30a8\u30b9\u30c8\u3092\u6e1b\u3089\u3057\u3001\u8ca0\u8377\u3092\u8efd\u6e1b\u3067\u304d\u307e\u3059\u3002<\/p>\n\n\n\n

\u7dba\u9e97\u306aAPI\u3092\u8a2d\u8a08\u3059\u308b\u306b\u306f\u6c17\u3092\u3064\u3051\u305f\u30445\u3064\u306e\u30dd\u30a4\u30f3\u30c8 | NTT Communications Developer Portal<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

API\u306e\u8a2d\u8a08\u306b\u304a\u3044\u3066\u3001\u958b\u767a\u8005\u306b\u3068\u3063\u3066\u306e\u4f7f\u3044\u52dd\u624b\u3084\u3001\u63d0\u4f9b\u8005\u306e\u30e1\u30f3\u30c6\u30ca\u30f3\u30b9\u30fb\u62e1\u5f35\u306e\u3057\u3084\u3059\u3055\u306b\u914d\u616e\u3059\u308b\u3053\u3068\u306f\u3068\u3066\u3082\u91cd\u8981\u3067\u3059\u3002
\n\u8a18\u4e8b\u3067\u306f\u3001\u7dba\u9e97\u306aAPI\u3092\u8a2d\u8a08\u3059\u308b\u305f\u3081\u306b\u914d\u616e\u3057\u3066\u304a\u304f\u3079\u304d\uff15\u3064\u306e\u30eb\u30fc\u30eb\u304c\u7d39\u4ecb\u3055\u308c\u3066\u3044\u307e\u3059\u3002<\/p>\n","protected":false},"author":1,"featured_media":28,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3,11],"tags":[65],"class_list":{"0":"post-89","1":"post","2":"type-post","3":"status-publish","4":"format-standard","5":"has-post-thumbnail","7":"category-news","8":"category-make-design","9":"tag-rest"},"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.apibank.jp\/contents\/wp-json\/wp\/v2\/posts\/89","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.apibank.jp\/contents\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.apibank.jp\/contents\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.apibank.jp\/contents\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.apibank.jp\/contents\/wp-json\/wp\/v2\/comments?post=89"}],"version-history":[{"count":1,"href":"https:\/\/www.apibank.jp\/contents\/wp-json\/wp\/v2\/posts\/89\/revisions"}],"predecessor-version":[{"id":90,"href":"https:\/\/www.apibank.jp\/contents\/wp-json\/wp\/v2\/posts\/89\/revisions\/90"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.apibank.jp\/contents\/wp-json\/wp\/v2\/media\/28"}],"wp:attachment":[{"href":"https:\/\/www.apibank.jp\/contents\/wp-json\/wp\/v2\/media?parent=89"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.apibank.jp\/contents\/wp-json\/wp\/v2\/categories?post=89"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.apibank.jp\/contents\/wp-json\/wp\/v2\/tags?post=89"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}