APIドã‚ュメントを支ãˆã‚‹æŠ€è¡“ - Qiita最近ã®ã‚¦ã‚§ãƒ–開発ã§ã¯å„機能ã”ã¨ã‚’APIã§ã¤ãªãŽè¾¼ã‚€æ™‚代ã«ãªã£ã¦ã„ã¾ã™ã€‚ ãã®ãŸã‚ã€å„ãƒãƒ¼ãƒ ãŒé–‹ç™ºã‚’ã—ã¦ã„ã上ã§ã€ ä»–ã®ãƒãƒ¼ãƒ ã«APIã®ä»•æ§˜ã‚’ä¼ãˆã‚‹æ–¹æ³•ã‚’ãã¡ã‚“ã¨ã¾ã¨ã‚ã¦ãŠãå¿…è¦ãŒå‡ºã¦ãã¦ã„ã¾ã™ã€‚ ãã‚“ãªä¸ã§APIドã‚ュメントã«ã©ã®ã‚ˆã†ãªå½¹å‰²ãŒæ±‚ã‚られã¦ã„㦠ã©ã®ã‚ˆã†ãªé¸æŠžè‚¢ãŒã‚ã‚‹ã‹ã€ä¸€æ—¦è‡ªåˆ†ã®æŠŠæ¡ã—ã¦ã„る知è˜ã‚’ã¾ã¨ã‚ã¦ã„ã¾ã™ã€‚ (ã“ã“ã§æ›¸ã„ã¦ã„ã‚‹APIã¯ã€httpã§ã‚¢ã‚¯ã‚»ã‚¹ã—ãŸã‚‰ã€JSONå½¢å¼ã§ãƒ¬ã‚¹ãƒãƒ³ã‚¹ã‚’è¿”ã™ã‚¦ã‚§ãƒ–サービスã®APIを指ã—ã¦ã„ã¾ã™) APIドã‚ュメントを用æ„ã™ã‚‹ä¸Šã§ã€ã™ãã«ã¶ã¤ã‹ã‚‹å£ APIドã‚ュメントを用æ„ã™ã‚‹å ´åˆã«ã€ä½•ã‚‚考ãˆãšã«Excelã‚„wikiã«ã¾ã¨ã‚ã‚‹ã¨ã€æ—©ã„段階㧠メンテナンスã®ã‚³ã‚¹ãƒˆ ã®å•é¡Œã«ã¶ã¤ã‹ã‚Šã¾ã™ã€‚ 『APIドã‚ュメントを書ã時間ãŒãªã„〠『本当ã«ãƒ‰ã‚ュメント通りã®çµæžœãŒè¿”ã£ã¦ãã‚‹ã‹ã€è©¦ã—ã¦ã¿ãªã„ã¨ã‚ã‹ã‚‰ãªã„〠『実際ã«è¿”ã£ã¦ãã‚‹APIã¨ãƒ¬ã‚¹ãƒãƒ³ã‚¹ãŒé•
API Documentation & Design Tools for Teams | Swagger
Rebuild: 35: You Don't Need API Version 2 (Kenn Ejima)
{{#tags}}- {{label}}
{{/tags}}