swaggerã§APIドã‚ュメントを書ã„ãŸã‚‰ã‚ã£ã¡ã‚ƒã¯ã‹ã©ã£ãŸè©± - kaz29Swaggerã¯ã€REST APIã®ä»•æ§˜ã¨ãã‚Œã«é–¢é€£ã™ã‚‹ãƒ„ール群ã®ç·ç§°ã§ã™ã€‚REST APIã®ä»•æ§˜ã‚’定義ã—ãŸJSONファイル(Swagger Spec)を軸ã«ä»¥ä¸‹ã®ã‚ˆã†ãªãƒ„ールã‹ã‚‰æ§‹æˆã•ã‚Œã¦ã„ã¾ã™ã€‚ Swagger UI - Swagger Spec ã‹ã‚‰å‹•çš„ã«APIドã‚ュメントを生æˆã™ã‚‹ãƒ„ール Swagger Editor - Swagger Specã®ã‚¨ãƒ‡ã‚£ã‚¿ Swagger Codegen - Swagger Specã‹ã‚‰ã‚¯ãƒ©ã‚¤ã‚¢ãƒ³ãƒˆã®ã‚³ãƒ¼ãƒ‰ã‚’生æˆã™ã‚‹ãƒ„ール 最近ã§ã¯ã€Open API InitiativeãŒAPIã®è¨˜è¿°ã®ãŸã‚ã«Swaggerを採用ã—ã¦è©±é¡Œã«ãªã‚Šã¾ã—ãŸã€‚ www.publickey1.jp APIドã‚ュメントã®ãƒ¡ãƒ³ãƒ†ã¯çµæ§‹é¢å€’ 一般的ã«APIã®ä»•æ§˜æ›¸ã¯ã€å¤ãã¯Excel/Wordãªã©ã‚’使ã£ãŸã‚Šã€æœ€è¿‘ã§ã¯Wikiã‚„Markdownå½¢å¼ã§è¨˜è¿°ã—ãŸã‚Šãªã©ãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆã«ã‚ˆã£ã¦
ã€API Blueprintã®ä½¿ã„方】Web APIã®ä»•æ§˜æ›¸ã‚’書ã・èªã‚€ãƒ»å®Ÿè¡Œã™ã‚‹ | DevelopersIO
{{#tags}}- {{label}}
{{/tags}}