REST APIドã‚ュメント作æˆãƒ„ールã¯apiary.ioãŒæ±ºå®šç‰ˆã‹ã‚‚ã—ã‚Œãªã„ - Qiita
背景 APIドã‚ュメントを書ãã®ãŒæ¥½ã«ãªã‚‹ãƒ„ールã¾ã¨ã‚ - Qiita iodocsã§ä¾¿åˆ©ãªREST APIドã‚ュメントを作æˆã™ã‚‹ - Qiita ã“ã‚Œã¾ã§ãšã£ã¨REST APIドã‚ュメントをwiki上ã§ç®¡ç†ã—ã¦ã„ã¦ã€é‡ãŸã„ページ上ã§ç‰¹æ®Šè¨˜æ³•ä½¿ã£ãŸã‚Šã€ã‚¹ã‚¿ã‚¤ãƒ«ã®èª¿æ•´ã«æ™‚é–“ã‚’å–られるã®ãŒè¾›ã‹ã£ãŸã€‚ãã“ã§è‰¯ã•ã’ãªãƒ‰ã‚ュメントツールを色々調ã¹ã¦ãŸã‚“ã ã‘ã©ã€æœ€çµ‚çš„ã«apiary.ioãŒä¸€ç•ªè‰¯ã•ãã†ã¨ã„ã†çµè«–ã«ãªã£ã¦ããŸã€‚ ã“ã®ã‚µãƒ¼ãƒ“スã®ä¸»ãªç‰¹å¾´ã€‚ markdown記法ã§APIドã‚ュメントを記述ã§ãã‚‹ ドã‚ュメントã®ç”Ÿæˆã¨åŒæ™‚ã«APIã®ãƒ¢ãƒƒã‚¯ã‚µãƒ¼ãƒã‚’用æ„ã—ã¦ãれる サインアップã‹ã‚‰5分ãらã„ã‚ã‚Œã°ãƒ‰ã‚ュメント公開ã§ãる。ドã‚ュメントã®ãƒ›ã‚¹ãƒˆå…ˆã‚’æ°—ã«ã—ãªãã¦ã‚‚ã„ã„。 特ã«ãƒ‰ã‚ュメントã¨ä¸€ç·’ã«ãƒ¢ãƒƒã‚¯ã‚’作ã£ã¦ãれるã®ã¯ä»–ã«ã¯ãªã„ãƒã‚¤ãƒ³ãƒˆã§ã‹ãªã‚Šä¾¿åˆ©ã€‚ 使ã£ã¦ã¿ã‚‹ サインアップã¯Githubアカウント㧠h
æ‹¡å¼µå¯èƒ½ãªWeb APIã®è¨è¨ˆåŽŸå‰‡ã¨ã€ãƒãƒ¼ã‚¸ãƒ§ãƒ³ç•ªå·ã‚’使ã†ç†ç”±ã«ã¤ã„ã¦
APIã®ãƒãƒ¼ã‚¸ãƒ§ãƒ‹ãƒ³ã‚°ã¯é™å±€åˆ†å²ã§ã‚„ã‚‹ã®ãŒè‰¯ã„ - Hidden in Plain Sightã«ã¯ãƒ–コメã—ãŸã®ã§ã™ãŒã€Rebuild: 35: You Don't Need API Version 2 (Kenn Ejima)ã§ã‚‚本件ã«è¨€åŠãŒã‚ã£ãŸã‚ˆã†ãªã®ã§ã€å°‘ã—一般論を書ã„ã¦ãŠããŸã„ã¨æ€ã„ã¾ã™ã€‚ â– Web APIã®è¨è¨ˆåŽŸå‰‡ã«ã¤ã„㦠ãã‚‚ãã‚‚ã€è‰¯ã„APIã¨ã¯ã©ã®ã‚ˆã†ãªç‰¹æ€§ã‚’ã‚‚ã¤ã‚‚ã®ã§ã—ょã†ã‹ï¼Ÿã€€ä¸€èˆ¬çš„ã«ã€ä»¥ä¸‹ã®ï¼’点ãŒæŒ™ã’られるã¨æ€ã„ã¾ã™ã€‚ æ‹¡å¼µãŒå®¹æ˜“ã§ã‚ã‚‹ 拡張時ã«å¾Œæ–¹äº’æ›æ€§ã‚’ç ´å£Šã—ãªã„ ウェブã®å ´åˆã¯ã€ã“ã‚Œã«åŠ ãˆã€ スケーラブルã§ã‚ã‚‹ HTTPã«èµ·å› ã™ã‚‹å•é¡Œã«ä¸Šæ‰‹ã«å¯¾å‡¦ã§ãã‚‹ ã“ã¨ãŒæ±‚ã‚られã¾ã™ã€‚ å‰ï¼’者ã¯ã‚¦ã‚§ãƒ–ã«é™ã‚‰ãªã„è¦ä»¶ã§ã™ã€‚ã“れを満ãŸã™è¨è¨ˆæ‰‹æ³•ã¨ã—ã¦ã¯ã€ リクエストãŠã‚ˆã³ãƒ¬ã‚¹ãƒãƒ³ã‚¹ã®ãƒ‘ラメータを拡張å¯èƒ½ã« 互æ›æ€§ã‚’壊ã™æ‹¡å¼µãŒå¿…è¦ãªå ´åˆã¯ã€é–¢æ•°åを変ãˆã‚‹ å¤ã„関数ã¯å¾“æ¥ã¨åŒã˜æ©Ÿèƒ½ã‚’
APIã®ãƒãƒ¼ã‚¸ãƒ§ãƒ‹ãƒ³ã‚°ã¯é™å±€åˆ†å²ã§ã‚„ã‚‹ã®ãŒè‰¯ã„ - Hidden in Plain Sight
ã¡ã‚‡ã£ã¨å‰ã«Twitterã§APIã®ãƒãƒ¼ã‚¸ãƒ§ãƒ‹ãƒ³ã‚°ã‚’ã©ã†ã‚„ã‚‹ã‹ã¿ãŸã„ãªè©±ã‚’ã—ã¦ã„ãŸã®ã§ã™ãŒã€ãã®ã¸ã‚“ã‚‚ã‚„ã‚‚ã‚„ã—ã¦ã„ã‚‹ã®ã§å°‘ã—æ•´ç†ã—ã¦ãŠããŸã„ãªã¨ã€‚ APIã®URLã‚’/api/v1/*ã¨ã‹ã£ã¦ã‚„ã‚‹ã®ã€ã‚„ã‚ãŸã»ã†ãŒã„ã„ã¨ãŠã‚‚ã†ã‚“ã ã‘ã©ãªã。ã„ã–v2を作るã¨ãªã£ãŸã¨ãã«ã€å¤§é‡ã®ã‚³ãƒ”ペãŒç™ºç”Ÿã—ã¦å¾Œæ‚”ã™ã‚‹ã‚ˆã€ã£ã¦ä¼ãˆãŸã„。— Kenn Ejima (@kenn) February 28, 2014 ã•ã¦ã€ã“ã‚Œã«ã¤ã„ã¦è‰²ã€…ã¨ç•°è«–・åè«–ã‚‚å«ã‚ãŸæ„見ãŒå‡ºãŸã®ã§ã™ãŒã€ã¾ãšã¯ã€å¤§æ˜”ã«URLæ–¹å¼ï¼ˆï¼ã‚³ãƒ³ãƒˆãƒãƒ¼ãƒ©åˆ†å‰²ï¼‰ã§ã‚„ã£ã¦ãã¦å¾Œæ‚”ã—ãŸã¼ããŒã€ï¼ˆ5å¹´ãらã„å‰ã‹ã‚‰ï¼‰ç¾åœ¨ã¯ã©ã†ã‚„ã£ã¦APIã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ã‚’管ç†ã—ã¦ã„ã‚‹ã‹ï¼Ÿã«ã¤ã„ã¦ç´¹ä»‹ã—ã¾ã™ã€‚ 基本原ç†ã¨ã—ã¦ã¯ã€ã‚³ãƒ”ペãŒå¤šç™ºã™ã‚‹æ ¹ã£ã“ã§åˆ†å²ï¼ˆï¼ã‚³ãƒ³ãƒˆãƒãƒ¼ãƒ©åˆ†å‰²ï¼‰ã˜ã‚ƒãªãã¦ã€å¿…è¦æœ€å°é™ã®ã¨ã“ã‚ã§é™å±€çš„ã«åˆ†å²ã™ã‚‹ã®ãŒã„ã„ã€ã¨ã„ã†è€ƒãˆæ–¹ã«åŸºã¥ãã¾ã™ã€‚ 一言ã§ã„ã†ã¨ã€ã€Œãƒ‘ラメー
Web API è¨è¨ˆã®ãƒ™ã‚¹ãƒˆãƒ—ラクティス集 "Web API Design - Crafting Interfaces that Developers Love" - フリーフォームフリークアウト
移転ã—ã¾ã—㟠http://please-sleep.cou929.nu/20130121.html
1
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
Amazon Simple Storage Service API Reference
Web API in Android World
{{#tags}}- {{label}}
{{/tags}}