API design guide  | Cloud API Design Guide  | Google Cloud
Send feedback API design guide Stay organized with collections Save and categorize content based on your preferences. Changelog Introduction This is a general design guide for networked APIs. It has been used inside Google since 2014 and is the guide that Google follows when designing Cloud APIs and other Google APIs. This design guide is shared here to inform outside developers and to make it eas
API è¨è¨ˆ: gRPCã€OpenAPIã€REST ã®æ¦‚è¦ã¨ã€ãれらを使用ã™ã‚‹ã‚¿ã‚¤ãƒŸãƒ³ã‚°ã‚’ç†è§£ã™ã‚‹ | Google Cloud å…¬å¼ãƒ–ãƒã‚°
※ã“ã®æŠ•ç¨¿ã¯ç±³å›½æ™‚é–“ 2020 å¹´ 4 月 11 æ—¥ã«ã€Google Cloud blog ã«æŠ•ç¨¿ã•ã‚ŒãŸã‚‚ã®ã®æŠ„訳ã§ã™ã€‚ ã»ã¨ã‚“ã©ã®ã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢ デベãƒãƒƒãƒ‘ーãŒã”å˜ã˜ã ã¨æ€ã„ã¾ã™ãŒã€API è¨è¨ˆã«ã¯ RPC 㨠REST ã® 2 ã¤ã®ä¸»è¦ãªãƒ¢ãƒ‡ãƒ«ãŒã‚ã‚Šã¾ã™ã€‚モデルã«é–¢ä¿‚ãªãã€ã»ã¨ã‚“ã©ã®ãƒ¢ãƒ€ãƒ³ API ã¯ã€ãªã‚“らã‹ã®æ–¹æ³•ã§åŒã˜ HTTP プãƒãƒˆã‚³ãƒ«ã«ãƒžãƒƒãƒ”ングã™ã‚‹ã“ã¨ã«ã‚ˆã£ã¦å®Ÿè£…ã•ã‚Œã¾ã™ã€‚ã¾ãŸã€RPC API è¨è¨ˆã§ã¯ã€RPC モデルã®ç¯„囲ã‹ã‚‰å¤–ã‚Œãšã« HTTP ã‹ã‚‰ 1 ã¤ã¾ãŸã¯ 2 ã¤ã®ã‚¢ã‚¤ãƒ‡ã‚¢ã‚’採用ã™ã‚‹ã“ã¨ãŒä¸€èˆ¬çš„ã«ãªã£ã¦ã„ã¾ã™ã€‚ã“ã‚Œã«ã‚ˆã‚Šã€API è¨è¨ˆè€…ã«æ示ã•ã‚Œã‚‹ã‚ªãƒ—ションã®ç¯„囲ãŒåºƒãŒã‚Šã¾ã—ãŸã€‚ã“ã®æŠ•ç¨¿ã§ã¯ã“れらã®ã‚ªãƒ—ションã«ã¤ã„ã¦èª¬æ˜Žã—ã€ã©ã‚Œã‚’é¸ã¶ã‹æ±ºã‚ã‚‹éš›ã«å½¹ç«‹ã¤ã‚¬ã‚¤ãƒ€ãƒ³ã‚¹ã‚’æä¾›ã—ã¾ã™ã€‚ gRPC 㯠RPC API を実装ã™ã‚‹ãŸã‚ã®ãƒ†ã‚¯ãƒŽãƒã‚¸ãƒ¼ã§ã€HTTP 2.0 ã‚’ãã®åŸºç›¤
スã‚ーマファースト開発ã®ã‚¹ã‚¹ãƒ¡ - onk.ninja
第 2 部 㧠ç¾åœ¨ 5 派閥ãらã„ã‚ã‚Šãã†ã§ã™ã€‚ ã¨æ›¸ã„ãŸä¸ã§ãªãœ OpenAPI ã‚’é¸ã‚“ã ã®ã‹ã¨ã„ã†ã¨ã€ JSON Hyper-Schema 㯠Hypermedia ã®æŠ€è¡“ãªã®ã§ã€1 サーム1 クライアントã€åŒä¸€ãƒãƒ¼ãƒ ã§ä¸¡æ–¹ã‚’見るã¨ã„ㆠprivate API ã§ã¯å‡ºç•ªãŒç„¡ã„。 RAML ã¯ã‚³ãƒŸãƒ¥ãƒ‹ãƒ†ã‚£è¦æ¨¡ãŒ OpenAPI, API Blueprint ã«æ¯”ã¹ã¦å°ã•ã‹ã£ãŸ OpenAPI 㨠API Blueprintã€ç”Ÿ JSON Schema ã ã¨ã€OpenAPI ãŒä¸€ç•ªã€ŒRESTful APIã€ã«ç‰¹åŒ–ã—ã¦ã„ã¦ã€ã‹ã¤è©³ç´°åº¦ãŒé«˜ã„ ã¨ã„ã£ãŸè¾ºã‚Šã§ã™ã€‚ OpenAPI 㯠ruby ã ã¨ãƒ©ã‚¤ãƒ–ラリ㌠(当時ã¯) å°‘ãªã‹ã£ãŸã®ã§ã™ãŒã€ã¾ã作れã°ä½•ã¨ã‹ãªã‚‹ã ã‚ã†ã¨æŽ¡ç”¨ã—ã¾ã—ãŸã€‚ 最近ã®ãƒˆãƒ¬ãƒ³ãƒ‰ã§ã‚‚ Swagger 1 å¼·ã«ãªã£ã¦ã‚‹ã£ã½ãã¦ã€è‰¯ã„é¸æŠžã‚’ã—ãŸãªãã¨æ€ã£ã¦ã„ã¾ã™ã€‚ Open
マイクãƒã‚µãƒ¼ãƒ“スã«ãŠã‘ã‚‹Web APIスã‚ーマã®ç®¡ç† ─ GraphQLã€gRPCã€OpenAPIã®ç‰¹å¾´ã¨ä½¿ã„ã©ã“ã‚｜ãƒã‚¤ã‚¯ãƒ©ã‚¹è»¢è·ãƒ»æ±‚äººæƒ…å ±ã‚µã‚¤ãƒˆ AMBI（アンビ）
マイクãƒã‚µãƒ¼ãƒ“スã«ãŠã‘ã‚‹Web APIスã‚ーマã®ç®¡ç†Â ─ GraphQLã€gRPCã€OpenAPIã®ç‰¹å¾´ã¨ä½¿ã„ã©ã“゠マイクãƒã‚µãƒ¼ãƒ“スã«ãŠã‘る通信方å¼ã®é¸æŠžã«ã¤ã„ã¦ã€ãŠãŠãŸï¼ˆota42y）ã•ã‚“ãŒã€GraphQL・gRPC・OpenAPIã¨ã„ã£ãŸä¸»ãªWeb APIスã‚ーマã®ç®¡ç†ã®åˆ©ç‚¹ã¨ä½¿ã„分ã‘を解説ã—ã¾ã™ã€‚ è¿‘å¹´æµè¡Œã—ã¦ã„るマイクãƒã‚µãƒ¼ãƒ“スアーã‚テクãƒãƒ£ã«ãŠã„ã¦ã¯ã€ã€Œã©ã†ã„ã£ãŸé€šä¿¡æ–¹å¼ã‚’é¸ã¶ã‹ã€ãŒé–‹ç™ºã®åŠ¹çŽ‡ã‚„サービスã®ä¿¡é ¼æ€§ã€ãƒ‘フォーマンスを大ããå·¦å³ã—ã¾ã™ã€‚ã“ã®è¨˜äº‹ã§ã¯ã€GraphQL・gRPC・OpenAPIãã‚Œãžã‚Œã®åˆ©ç‚¹ã¨é©åˆ‡ãªä½¿ã„分ã‘ã«ã¤ã„ã¦è§£èª¬ã—ã¾ã™ã€‚ マイクãƒã‚µãƒ¼ãƒ“スã«ãŠã‘ã‚‹Web API管ç†ã®é‡è¦æ€§ Schema First Developmentã¨Web API 人ã§ã¯ãªãプãƒã‚°ãƒ©ãƒ ãŒå‡¦ç†ã§ãるよã†ç®¡ç†ã™ã‚‹ Web APIã®ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹å®šç¾©æ‰‹æ³•ã®æ¯”較 OpenAPI ─ R
「GraphQLã€å¾¹åº•å…¥é–€ ─ RESTã¨ã®æ¯”較ã€API・フãƒãƒ³ãƒˆåŒæ–¹ã®å®Ÿè£…ã‹ã‚‰å¦ã¶ï½œãƒã‚¤ã‚¯ãƒ©ã‚¹è»¢è·ãƒ»æ±‚äººæƒ…å ±ã‚µã‚¤ãƒˆ AMBI（アンビ）
scalaråž‹ã‚’æ–°ã—ã定義ã™ã‚‹ãŸã‚ã«ã¯scalarã‚ーワードを使ã„ã¾ã™ã€‚例ãˆã°ã€Dateåž‹ã‚’æ–°ã—ã定義ã™ã‚‹ã«ã¯æ¬¡ã®ã‚ˆã†ã«ã—ã¾ã™ã€‚ scalar Date スã‚ーマã§ã¯ã“ã‚Œã ã‘ã§ã™ãŒã€å®Ÿéš›ã«ä½¿ã†éš›ã¯GraphQL処ç†ç³»ã«å¯¾ã—ã¦ã•ã‚‰ã«ã‚·ãƒªã‚¢ãƒ©ã‚¤ã‚ºã¨ãƒ‡ã‚·ãƒªã‚¢ãƒ©ã‚¤ã‚ºã‚’定義ã™ã‚‹ã“ã¨ã«ãªã‚Šã¾ã™ã€‚ GraphQL組ã¿è¾¼ã¿ã®scalaråž‹ã¯å…ˆã«ã‚ã’ãŸã‚‚ã®ã ã‘ãªã®ã§ã€ä¾‹ãˆã°ãƒã‚¤ãƒŠãƒªã€æ—¥ä»˜ã¨æ™‚刻ã€HTML/XMLã€BigIntãªã©ã‚’å¿…è¦ã«å¿œã˜ã¦è¿½åŠ ã™ã‚‹ã“ã¨ã«ãªã‚‹ã§ã—ょã†ã€‚ãŸã ã—ãã®å ´åˆã€ã‚µãƒ¼ãƒãƒ¼ã‚µã‚¤ãƒ‰ã¨ã‚¯ãƒ©ã‚¤ã‚¢ãƒ³ãƒˆã‚µã‚¤ãƒ‰ã§ã‚·ãƒªã‚¢ãƒ©ã‚¤ã‚ºãƒ»ãƒ‡ã‚·ãƒªã‚¢ãƒ©ã‚¤ã‚ºã®å®Ÿè£…を一致ã•ã›ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ Enum enum（イナム）ã¯scalaråž‹ã®ä¸€ç¨®ã§ã€ç‰¹å®šã®å€¤ã®ã¿ã‚’æŒã¤åž‹ã§ã™ã€‚例ãˆã°ã€çµ„ã¿è¾¼ã¿scalaråž‹ã§ã‚ã‚‹Booleanã‚’enumã§å®£è¨€ã™ã‚‹ã¨æ¬¡ã®ã‚ˆã†ã«ãªã‚‹ã§ã—ょã†ã€‚ enum Boolean { true false
1
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
{{#tags}}- {{label}}
{{/tags}}