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å½¢å¼ã§è¨˜è¿°ã—ãŸã‚Šãªã©ãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆã«ã‚ˆã£ã¦
Markdownドã‚ュメントをgithubã§ç®¡ç†ã—ã¦ã€ã¯ã¦ãªãƒ–ãƒã‚°ã§ãƒ›ã‚¹ãƒˆã™ã‚‹ ~ Mackerelã®å ´åˆ - Hatena Developer Blog
[Apiary]Markdownã§å§‹ã‚ã‚‹API開発ã¨APIドã‚ãƒ¥ãƒ¡ãƒ³ãƒˆä½œæˆ | DevelopersIO![[Apiary]Markdownã§å§‹ã‚ã‚‹API開発ã¨APIドã‚ãƒ¥ãƒ¡ãƒ³ãƒˆä½œæˆ | DevelopersIO](https://cdn-ak-scissors.b.st-hatena.com/image/square/60d7120d91185f1739fec5fcbd006f066b98e9f6/height=288;version=1;width=512/https%3A%2F%2Fdevio2023-media.developers.io%2Fwp-content%2Fuploads%2F2015%2F02%2Fapiary-logo.png){kind=logo}
JSON Hyper-Schema ã‹ã‚‰APIドã‚ュメントã¨Goã®ã‚³ãƒ¼ãƒ‰ã‚’自動生æˆã™ã‚‹ | The Wacul Blog
REST APIドã‚ュメント作æˆãƒ„ールã¯apiary.ioãŒæ±ºå®šç‰ˆã‹ã‚‚ã—ã‚Œãªã„ - Qiita
ã‚ã‹ã‚Šã‚„ã™ã„README.mdを書ã
{{#tags}}- {{label}}
{{/tags}}