api-guidelines/Guidelines.md at vNext · microsoft/api-guidelinesYou signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
Swaggerã®æ¦‚è¦ã‚’ã¾ã¨ã‚ã¦ã¿ãŸã€‚ - Qiita
æ¦‚è¦ æœ€è¿‘ã¯ API Blueprint ã§ä»•æ§˜æ›¸ã‚’書ãã“ã¨ãŒå¤šã‹ã£ãŸã®ã§ã™ãŒã€Swagger ãŒä¸–界標準ã«ãªã‚‹ã‹ã‚‚ã—ã‚Œãªã„ã€ã¨ã„ã†ã“ã¨ã‚‚ã‚ã‚Šã€é–‹ç™ºã®åŠ¹çŽ‡åŒ–を進ã‚ã‚‹ãŸã‚ã«ã‚‚概è¦ã‚’ã¾ã¨ã‚ã¦ã¿ã‚ˆã†ã¨æ€ã£ãŸæ¬¡ç¬¬ã§ã™ã€‚ Swaggerã¨ã¯ Swagger 㯠RESTful APIを構築ã™ã‚‹ãŸã‚ã®ã‚ªãƒ¼ãƒ—ンソースã®ãƒ•ãƒ¬ãƒ¼ãƒ ワークã®ã“ã¨ã§ã™ã€‚「Open API Initiativeã€ã¨ã„ã†å›£ä½“ãŒRESTful APIã®ã‚¤ãƒ³ã‚¿ãƒ¼ãƒ•ã‚§ã‚¤ã‚¹ã®è¨˜è¿°ã‚’ã™ã‚‹ãŸã‚ã®æ¨™æº–フォーマットを推進ã—ã¦ã„ã¦ã€ãã®æ¨™æº–フォーマットãŒSwaggerã§ã™ã€‚Swaggerã«ã¯å¤šãã®ä¾¿åˆ©ãªãƒ„ールãŒæä¾›ã•ã‚Œã¦ã„ã‚‹ã“ã¨ã‚‚ã‚ã‚Šã€å¤šãã®ãƒ¡ãƒªãƒƒãƒˆã‚’享å—ã§ããã†ã§ã™ã€‚ Swagger Spec を書ã„ã¦ãŠã‘ã°è‡ªå‹•çš„ã«ãƒ‰ã‚ュメント生æˆã¾ã§ã—ã¦ãã‚Œã€ãã‚Œã ã‘ã§ã¯ãªãã€ãƒ‰ã‚ュメントã‹ã‚‰å®Ÿéš›ã®ãƒªã‚¯ã‚¨ã‚¹ãƒˆã‚’投ã’られる優れもã®ã§ã™ã€‚ Swaggerã®ãƒ„ール群
Common REST Mistakes
When designing your first REST system there are a variety of mistakes people often make. I want to summarize them so that you can avoid them. If any are unclear, ask for more information on rest-discuss. Using HTTP is not enough. You can use HTTP in a Web service without SOAP or XML-RPC and still do the logical equivalent of SOAP or XML-RPC. If you're going to use HTTP wrong you would actually be
Flickr and Good URI Design « Michael Eakes
Cloud/SaaS Architecture, Engineering, and Deployment I noticed that Flickr had some pretty sweet URIs, but I wanted to find out exactly what it was that made them good. To brush up on URI design, I scoured this great list of resources compiled by Tanya Rabourn: The User Interface of URLs (Paul E. Hoffman, 1995) Cool URI’s Don’t Change (Tim Berners-Lee 1998) URL’s as UI (Jakob Nielsen, 1999) URL’s
Ywcafe.net
Ywcafe.net This Page Is Under Construction - Coming Soon! Why am I seeing this 'Under Construction' page? Related Searches: High Speed Internet Anti Wrinkle Creams Credit Card Application Best Penny Stocks fashion trends Trademark Free Notice Review our Privacy Policy Service Agreement Legal Notice Privacy Policy|Do Not Sell or Share My Personal Information
naoyaã®ã¯ã¦ãªãƒ€ã‚¤ã‚¢ãƒªãƒ¼ - REST 㨠GET
RESTful ãªã‚¢ãƒ—リケーションã§ã¯ã€å¯¾è±¡ã¨ã™ã‚‹ãƒªã‚½ãƒ¼ã‚¹ã«å‰¯ä½œç”¨ã‚’åŠã¼ã™ã¨ã㯠POST ãªã‚Š PUT を使ã†ã®ãŒãƒ™ã‚¹ãƒˆãƒ—ラクティス。(ベストプラクティスã¨ã„ã†è¨€è‘‰ã‚’使ã£ã¦ã¿ãŸã‹ã£ãŸ!) ã“ã®è€ƒãˆæ–¹ã¯ã‚¦ã‚§ãƒ–アプリケーションを作るã¨ãã«ã€GET ã«ã™ã‚‹ã‹ POST ã«ã™ã‚‹ã‹ã«æ˜Žç¢ºãªæŒ‡é‡ã‚’与ãˆã¦ãã‚Œã¦ã™ã£ãã‚Šã—ã¾ã™ã€‚ ã§ã€ãµã¨æ€ã£ãŸã‚“ã ã‘ã©ã€è¡¨é¢çš„ã«ã¯ GET ã§ã‚ˆã•ãã†ã ã‘ã©ã‚‚実ã¯ä¸ã§ãƒªã‚½ãƒ¼ã‚¹ã«å‰¯ä½œç”¨ãŒåŠã‚“ã§ã„るよã†ãªä»£ç‰©ã¯ã©ã†ã—ãŸã‚‰ã„ã„ã‚“ã ã‚ã†ãªã¨ã„ã†ã“ã¨ã€‚例ãˆã°æ¤œç´¢ã‚¨ãƒ³ã‚¸ãƒ³ãªã‚“ã‹ã§ã€ã‚¯ãƒªãƒƒã‚¯ã«åˆã‚ã›ã¦å¾Œã‚ã§ã‚¯ãƒªãƒƒã‚¯å›žæ•°ã‚’æ•°ãˆã¦ãŸã‚Šçµ±è¨ˆã¨ã£ã¦ãŸã‚Šã™ã‚‹ã‚‚ã®ãŒã‚ã‚‹ã¨æ€ã†ã‚“ã ã‘ã©ã€ãã†ã„ã†é¡žã€‚ ウェブサイトã®æ¤œç´¢ã‚¨ãƒ³ã‚¸ãƒ³ã¨ã‹ã ã¨ã‚¯ãƒªãƒƒã‚¯å¯¾è±¡ã® URI ãŒå·®ã™ãƒªã‚½ãƒ¼ã‚¹ãŒå¤–部サイトã§ã¡ã‚‡ã£ã¨ã‚¤ãƒ¡ãƒ¼ã‚¸ã—ã¥ã‚‰ã„ã®ã§ã€ä¾‹ãˆã° search.cpan.org ãªã©ã€‚モジュールã®æ¤œç´¢çµæžœã‹ã‚‰ã®ã‚¯ãƒªãƒƒã‚¯å›žæ•°ã‚’
Authenticating REST Requests
Authenticating REST Requests Every non-anonymous request to S3 must contain authentication information to establish the identity of the principal making the request. In REST, this is done by first putting the headers in a canonical format, then signing the headers using your AWS Secret Access Key. There are two ways to send your signature with a request. The first is to put your AWS Access Key ID
ã¯ã¦ãªå„サービスã®æ©Ÿèƒ½å¤‰æ›´ã€ãŠçŸ¥ã‚‰ã›ãªã© - ã¯ã¦ãªæŠ€è¡“発表会日記 - 2月6æ—¥ã®æŠ€è¡“勉強会
8月17æ—¥ã®æŠ€è¡“勉強会 - Flexレイアウト手書ã勉強会 8月17æ—¥ã«è¡Œã‚ã‚Œã¾ã—ãŸæŠ€è¡“発表会ã®å†…容を撮影ã—ãŸå‹•ç”»ãƒ•ã‚¡ã‚¤ãƒ«/資料を公開ã„ãŸã—ã¾ã—ãŸã€‚内容ã¯ä»¥ä¸‹ã®ã¨ãŠã‚Šã§ã™ã€‚ テーマ Flexレイアウト手書ã勉強会 発表者 d:id:secondlife 勉強会動画 ダウンãƒãƒ¼ãƒ‰â€¦
yohei-y:weblog: 良ㄠURI ã®è¨è¨ˆ
URI ã¯ç¶ºéº—ã§ã‚ã‚‹ã¹ãã€ã¨å¸¸ã€…æ€ã£ã¦ã„ã‚‹ã‚“ã§ã™ãŒã€ã‚ˆã„ページを発見ã—ã¾ã—ãŸã€‚ Michael Eakes ã®ã“ã®ã‚¨ãƒ³ãƒˆãƒªã§ã™ã€‚ Tanya Rabourn ãŒãƒªã‚¹ãƒˆã‚¢ãƒƒãƒ—ã—ã¦ã„る文献一覧ã‹ã‚‰ã‚¨ãƒƒã‚»ãƒ³ã‚¹ã‚’ã¾ã¨ã‚ã¦ãã‚Œã¦ã„ã¾ã™ã€‚ æ›°ãã€ã‚ˆãè¨è¨ˆã•ã‚ŒãŸ URI ã¨ã¯ 変らãªã„(don't change) 人間ãŒæŽ¨æ¸¬å¯èƒ½(are human guessable) è«–ç†çš„(ファイルシステムをåæ˜ ã™ã‚‹å¿…用ãŒãªã„) (are logical (no need to mirror a filesystem)) ã‚µã‚¤ãƒˆæ§‹é€ ã‚’ãƒ“ã‚¸ãƒ¥ã‚¢ãƒ©ã‚¤ã‚ºã™ã‚‹ã®ã«å½¹ç«‹ã¤(help visualize the site structure) çŸã„(are short) å°æ–‡å—を使ã†(use lowercase) 予期ã•ã‚Œãªã„記å·ã‚’使ã‚ãªã„(don't use unexpected punctuation) å•åˆã›ãƒ‘ラメータãª
ãŸã ã®ã«ã£ã (2006-03-01) - ãŠã‚Œã ã£ãŸã‚‰ãƒ•ã‚©ãƒˆè”µAPIã‚’ã“ã†ã™ã‚‹
â– Appleæ–°è£½å“ iPod Hi-Fiã€ãƒ€ã‚»ã‡ã€‚ã“ã‚ŒãŒApple製å“ã ãªã‚“ã¦ä¿¡ã˜ã‚‰ã‚“ãªã„。他社製å“ãŒé–“é•ã£ã¦ç´›ã‚Œè¾¼ã‚“ã ã‚“ã˜ã‚ƒãªã„ã®ã‹ã€‚ Mac miniã¯ã€ç›¸å¤‰ã‚らãšã¡ã‚‡ã£ã¨æ¬²ã—ã„。やã¯ã‚Šå°ã•ã„機械ã«ã¯æƒ¹ã‹ã‚Œã‚‹ã€‚ã“ã‚Œã§WindowsãŒå‹•ã‘ã°ãªã(â†ã ã„ãªã—)。 â– ãŠã‚Œã ã£ãŸã‚‰ãƒ•ã‚©ãƒˆè”µAPIã‚’ã“ã†ã™ã‚‹ ã›ã£ã‹ãユーザã§ã‚‚ã‚ã‚‹ã®ã§(æºå¸¯ã®ãƒãƒƒã‚¯ã‚¢ãƒƒãƒ—ã«ã—ã‹ä½¿ã£ã¦ãªã„ã‘ã©)ã€Î²å…¬é–‹ã•ã‚ŒãŸãƒ•ã‚©ãƒˆè”µAPI(アナウンス)を使ã£ã¦ã¿ã‚‹ã“ã¨ã«ã—ãŸâ€¦â€¦ã‚“ã ã‘ã©ã€æ¦‚è¦ã‚’èªã‚“ã§ã€Œã¡ã‚‡ã£ã¨å¾…ã¦ã€ã¨æ€ã£ãŸã€‚ フォト蔵APIã¯å…¨ã¦RESTã§æä¾›ã•ã‚Œã¦ã„ã¾ã™ã€‚機能毎ã®å€‹åˆ¥ã®URLã«å¯¾ã—ã¦å¿…è¦ãªãƒ‡ãƒ¼ã‚¿ã‚’POSTã—ã¾ã™ã€‚çµæžœã¯å…¨ã¦XMLã§è¿”ã£ã¦ãã¾ã™ã€‚ ãˆãƒ¼ã¨ã€GETを使ã†ã¹ãAPIã§ã‚‚POSTã§ã™ã‹ã。ãã‚Œã€RESTã˜ã‚ƒãªãã¦ãŸã ã®ã€Œãªã‚“ã¡ã‚ƒã£ã¦RPCã€ã ã—。……ã¨ã¯è¨€ã£ãŸã‚‚ã®ã®ã€è‡ªåˆ†ã ã£ã¦RESTã‚’ç†è§£ã—ã¦ã„ã‚‹ã‹
yohei-y:weblog: REST ã¯é›£ã—ã„ã€ã ã‹ã‚‰ã“ãé¢ç™½ã„
知りåˆã„ã«æ•™ãˆã¦ã‚‚らã£ã¦çŸ¥ã£ãŸã®ã ãŒã€ä»Šæœˆã®æ—¥çµŒã‚½ãƒ•ãƒˆã‚¦ã‚¨ã‚¢ã¯ Web プãƒã‚°ãƒ©ãƒŸãƒ³ã‚°ã®ç‰¹é›†ã§ã‚る。 ã¡ã‚‡ã£ã¨ç«‹ã¡èªã¿ã—ãŸã¨ã“ã‚ã€å†…容㯠Web 2.0 ã¾ã‚ã‚Šã®è¨˜äº‹ã ã£ãŸã€‚ ãã®ç‰¹é›†ã®ä¸ã®å›²ã¿è¨˜äº‹ã§ REST ã¨åƒ•ã®åå‰ãŒå‡ºã¦ãã‚‹ã¨ã“ã‚ãŒã‚る。 「ã‚ã‹ã‚Šã¥ã‚‰ã„ REST ã¨ã„ã†è¨€è‘‰ã€ã¨ã„ã†ã‚¿ã‚¤ãƒˆãƒ«ã§ã€ REST ãŒã‚¢ãƒ¼ã‚テクãƒãƒ£ã‚¹ã‚¿ã‚¤ãƒ«ã§ã‚ã‚‹ã“ã¨ã€ 一方㧠REST API ã¯ã€Œãƒ›ãƒ¼ãƒ ページã€ã®ã‚ˆã†ãªèª¤ç”¨ã§ã‚ã‚‹ãŒã€ãã¡ã‚‰ã®æ–¹ãŒä¸€èˆ¬çš„ã«ãªã£ã¦ã—ã¾ã£ã¦ã„ã‚‹ã“ã¨ã€ ãŒç°¡å˜ã«è¨˜è¿°ã•ã‚Œã¦ã„ãŸã€‚ REST == HTTP GET+XML ã®ã‚ˆã†ãªç´¹ä»‹ã‚ˆã‚Šã‚‚1万å€ã‚ˆã‹ã£ãŸã—〠何よりã“ã†ã„ã†åˆå¿ƒè€…å‘ã‘ã®ãƒ¡ã‚¸ãƒ£ãƒ¼(?)ãªé›‘誌記事㧠REST ã«è¨€åŠã™ã‚‹ã‚ˆ ã†ã«ãªã£ã¦ã€æœ¬å½“ã«ã‚ˆã‹ã£ãŸã¨æ€ã†ã€‚1å¹´å‰ã«ã¯è€ƒãˆã‚‰ã‚Œãªã‹ã£ãŸã“ã¨ã 。 ãŸã ã€æ°—ã«ãªã£ãŸã®ã¯ REST ãŒé›£ã—ãã¦ã‚ã‹ã‚Šã¥ã‚‰ã„ã€ã¨ã„ã†è©±ã 。 ãりゃ確ã‹
yohei-y:weblog: REST ã£ã¦ã‚„ã£ã±ã‚Šé›£ã—ã„ã‹ã‚‚。
å‰ã®ã‚¨ãƒ³ãƒˆãƒªã§ã“ã‚“ãªã“ã¨ã‚’書ã„ãŸã°ã‹ã‚Šã ã‘ã‚Œã©ã€REST ã£ã¦ã‚„ã£ã±ã‚Šã©ã†ã‚ˆã€ã¨ã„ã†æ°—分ã«ãªã£ãŸã®ã§ä¹…々㫠blog ã‚’æ›´æ–°ã—ã¦ã¿ã‚‹ã€‚ ãŸã ãŸã ã—ã•ã‚“ã®ãŠã‚Œã ã£ãŸã‚‰ãƒ•ã‚©ãƒˆè”µAPIã‚’ã“ã†ã™ã‚‹ã‚’èªã‚“ã§ã€åƒ•ãŒ del.icio.us ã«æ›¸ã„ãŸæ„Ÿæƒ³ã¯ +1。ID == URI ã§ã™ã‚ˆã。Cool URI ã¯åè©žã§ã‚ã‚‹ã¹ãã€ã¨ã„ã†ã®ã¯å¼·èª¿ã—ãŸã„。「日本RESTå”会ã€å…¥ã‚ŠãŸããªã„ãªãƒ¼(笑)。ã¿ã‚“ãªä¼‘ã‚“ã§ãㆠã¨ã„ã†ã‚‚ã®ã€‚ãŸã ã•ã‚“ã®ã‚¨ãƒ³ãƒˆãƒªã§ã¯ URI ã¨æ›¸ãã¹ãã¨ã“ã‚㌠ID ã«ãªã£ã¦ã¦ã¡ã‚‡ã£ã¨æ°—ã«ãªã£ãŸã‚Šã€ã€Œä½œæ³•ã€ã¯ã€Œã‚¢ãƒ¼ã‚テクãƒãƒ£ã€ã˜ã‚ƒãªãã¦ã€Œã‚¢ãƒ¼ã‚テクãƒãƒ£ã‚¹ã‚¿ã‚¤ãƒ«ã€ã ã€ã¨ã‹æ€ã£ãŸã®ã ã‘ã‚Œã©ã€ã§ã‚‚本ç‹ã¨ã—ã¦ã¯ç´å¾—ã®å†…容ã ã£ãŸã€‚ ã—ã‹ã—ã€ãŸã ã•ã‚“ã®ã‚¨ãƒ³ãƒˆãƒªã®ã€ãŸã‹ã¯ã—ã•ã‚“ã‚„ mizzy ã•ã‚“ã®ã‚³ãƒ¡ãƒ³ãƒˆã‚’èªã‚“ã§ã†ãƒ¼ã‚“ã¨å”¸ã£ã¦ã—ã¾ã£ãŸã€‚ 僕ã«ã¯ãŠäºŒäººã®è¨€ã„ãŸã„ã“ã¨ãŒã‚ã‹ã‚‹ã€‚ã‚“ã§ä¸¡æ–¹é–“é•ã£ã¦ã„ãªã„ã¨æ€ã†ã€‚
yohei-y:weblog: Atom ã§ä»¶æ•°å–å¾—
ãªã‚“ã‹å‚¬ä¿ƒã•ã‚Œã¡ã‚ƒã£ãŸã¿ãŸã„ãªã®ã§ :-) 詳ã—ã書ã„ã¦ã¿ã¾ã™ã€‚ ã¯ã¦ãªã®ãƒ–ックマーク件数å–å¾— API ã„ã„ã§ã™ã。 今ã•ã‚‰ xml-rpc ã‹ã‚ˆ! ã¨ã„ã†ãƒ„ッコミã¯ç½®ã„ã¦ãŠã„ã¦ã€ データé‡è¦ãªä¸–ã®ä¸ã§æœ‰ç”¨ãªã‚³ãƒ³ãƒ†ãƒ³ãƒ„(メタデータ)ã«ãƒªãƒ¼ãƒã™ã‚‹ 方法ãŒå¢—ãˆã‚‹ã®ã¯å–œã°ã—ã„ã“ã¨ã§ã™ã€‚ ãã†ãã†ã€ã“ã†ã„ㆠAPI ã‚’ AtomPP ã§å®Ÿè£…ã™ã‚‹ã¨ã—ãŸã‚‰ã©ã‚“ãªæ„Ÿã˜ãªã‚“ã ã‚ã†ã€‚ãã‚‚ãã‚‚ã†ã¾ãフィードã§å®šç¾©ã§ãã‚‹ã®ã‹ã€‚æ•™ãˆã¦å‰ã„人! å‰ã„人ã˜ã‚ƒãªã„ã‘ã©ã€çµè«–ã‹ã‚‰ã„ãˆã°ã€ Atom Publishing Protocol (APP) ãã®ã¾ã¾ã˜ã‚ƒç„¡ç†ã§ã™ã€‚ ã‚„ã£ã¦ã‚‚ã„ã„ã‘ã©ã©ã†ã—ã¦ã‚‚ç„¡ç†ãŒå‡ºã¦ã—ã¾ã„ãã†ã€‚ ãã‚‚ãも目的ãŒé•ã†ã®ã ã‹ã‚‰ã€ã“ã“ã¯é‡Žè‰¯ XML/プãƒãƒˆã‚³ãƒ«ã§ã„ã„ã®ã§ã¯ã€‚ ãŸã ã€çµæžœã‚’フィードã§å–れるã¨ãã‚Œãªã‚Šã«å¬‰ã—ã„ã‹ã‚‚ã—ã‚Œãªã„。 普通 REST ã§æ¤œç´¢ã™ã‚‹ã¨ã㯠query string を使ã£
1
ランã‚ング
ランã‚ング
ランã‚ング
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
https://twitter.com/iwashi86/status/1547051699503857667
Representational State Transfer (REST) « Michael Eakes
ã¤ã¾ã‚Šæ¤œç´¢ã‚¨ãƒ³ã‚¸ãƒ³ã‚‚?ã‚„=を嫌ㆠ― 動的ページã¨é™çš„ページ(3) - Webビジãƒã‚¹ã‚³ãƒ³ã‚µãƒ«ã‚¿ãƒ³ãƒˆã®ãƒã‚¿å¸³
動的ページã¨é™çš„ページ(1) 一般論
{{#tags}}- {{label}}
{{/tags}}