Autodoc - r7kamura blogé—‡Advent Calendar 1日目ã®è¨˜äº‹ã¨ã—ã¦ã€æœ€è¿‘ã®é–‹ç™ºã«ãŠã‘る心ã®é—‡ã«è§¦ã‚Œã¾ã™ã€‚ 最近開発ã—㟠Autodoc ã¨ã„ã†ãƒ„ールã«ã¤ã„ã¦ç°¡å˜ã«èª¬æ˜Žã—ãŸå¾Œã€ ã“ã®æ‰‹ã®ãƒ„ールã®é–‹ç™ºã«ã‚ãŸã£ã¦è€ƒãˆã¦ã„ãŸã€ 創作活動ã®åœ¨ã‚Šæ–¹ã‚„ã€ç¤¾ä¼šã®æ–¥åŠ›ã€25æ³å®šå¹´èª¬ãªã©ã«ã¤ã„ã¦è§¦ã‚Œã‚ˆã†ã¨æ€ã„ã¾ã™ã€‚ Autodocã¨ã¯ Rack applicationã§å®Ÿè£…ã•ã‚ŒãŸAPIã«å¯¾ã—ã¦ã€RSpecã§æ›¸ã‹ã‚ŒãŸãƒ†ã‚¹ãƒˆã‚’å…ƒã«APIドã‚ュメントを生æˆã™ã‚‹ã‚‚ã®ã€‚ テストを実行ã™ã‚‹ã¨ã€ãƒ†ã‚¹ãƒˆä¸ã«ç™ºè¡Œã—ãŸãƒªã‚¯ã‚¨ã‚¹ãƒˆã‚„レスãƒãƒ³ã‚¹ã€ãã®ãƒ†ã‚¹ãƒˆã«ä»˜ã‘られãŸãƒ¡ãƒƒã‚»ãƒ¼ã‚¸ã‚’å…ƒã«ã€ 良ã„æ„Ÿã˜ã«æƒ…å ±ã‚’ã¾ã¨ã‚ã€Markdownå½¢å¼ã§APIドã‚ュメントを記ã—ãŸãƒ•ã‚¡ã‚¤ãƒ«ã‚’生æˆã—ã¦ãれる。 例ãˆã°GitHubã§ã¯Markdownファイルをé©å½“ã«æç”»ã—ã¦ãれるã®ã§ã€ 下図ã®ã‚ˆã†ã«GitHub上ã§ç°¡å˜ã«ãƒ‰ã‚ュメントを閲覧出æ¥ã‚‹ã‚ˆã†ã«ãªã‚‹ã€‚ テストã®æ›¸ãæ–¹
{{#tags}}- {{label}}
{{/tags}}