首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

smart-doc接口文档生成工具

Part1文章首推 支付宝接口对接 高德地图调用 验证码登录 QQ邮箱登录 Part2今日主题:smart-doc接口文档生成工具 这个一个接口生成文档工具,之前我也有推荐swagger这款工具,但是这款工具在生产环境中却不怎么用...,对代码的侵入性太高了,现在来介绍一下smart-doc这款接口文档工具吧,他可以识别javadoc注释然后生成文档,也就是说只要你采用正常的注释就好了。...("/test") public String test(String str){ return str; } } 这样我们就写好了两个控制类 现在我们去写一个文档生成工具...将会把所有接口生成到一个Markdown、HHTML或者AsciiDoc中 config.setAllInOne(true); //HTML5文档,建议直接放到src/...main/resources/static/doc下,Smart-doc提供一个配置常量HTML_DOC_OUT_PATH config.setOutPath(DocGlobalConstants.HTML_DOC_OUT_PATH

1.5K50
您找到你想要的搜索结果了吗?
是的
没有找到

使用swagger作为restful api的doc文档生成

使用swagger作为restful api的doc文档生成 初衷 记得以前写接口,写完后会整理一份API接口文档,而文档的格式如果没有具体要求的话,最终展示的文档则完全决定于开发者的心情。...于是发现了swagger,自动生成文档的工具。...swagger会扫描配置的API文档格式自动生成一份json数据,而swagger官方也提供了ui来做通常的展示,当然也支持自定义ui的。不过对后端开发者来说,能用就可以了,官方就可以了。...效果为先,最终展示doc界面,也可以设置为中文: ?...API doc的显示路由是:http://localhost:8080/swagger-ui.html 如果项目是一个webservice,通常设定home / 指向这里: @Controller public

2.6K20

好物分享 | 小而巧的API文档生成工具之smart-doc

smart-doc介绍 一个 java restful api 文档生成工具,不用像Swagger一样写大量注解,完全基于接口源码分析来生成接口文档,但是需要按照 java的标准注释写。...smart-doc的最佳搭档 smart-doc + Torna 组成的文档生成和管理解决方案,使用smart-doc无侵入完成JAVA源代码分析和提取注释生成API文档,自动将文档推送到Torna企业级接口文档管理平台...谁在使用smart-doc smart-doc的优缺点 简单总结了几个特别明显以及我认为最关键的几个优点如下: 非侵入式接口文档生成 需要按照java文档注释规范对接口及相关对象添加注释 编译文件后需要手动运行插件生成接口文档...设计思路不同,smart-doc 是基于 源码分析的,它生成api文档是通过分析JAVA源码主要是通过 注释 和 系统自带注解,来实现文档的 生成,而 swagger 是运行时 自动生成在线文档,并且...生成的API接口文档页面,因为有的已经使用了其他产品,可以将smart-doc生成的json同步到现有的产品,当然如果你只使用smart-doc的话,不需要配置文件映射。

5.3K30
领券