社区快餐连锁店“五味小面”获数百万元天使轮融资
06-18
前言》每次开发新项目或者新的界面功能，首先要做的就是提供界面文档。说到界面文档，当然要用到Markdown。
各种复制粘贴字段可选，字段注释，请求返回示例等等，所以我想到了开发一个插件来解决重复文档的问题。第一次向外界提供接口，要写文档，很麻烦，而且文档消耗了很多时间，我也用过一些文档工具和在线编写工具，但是在。
end 我自己比较喜欢手写文档。使用的生成工具Swagger：添加依赖、配置类和描述信息，然后在方法和实体上添加注释。
启动项目后，可以通过访问 xxxx/swagger-ui.html 查看接口文档。 ; API Doc：添加配置文件和注释，安装npm并通过执行命令生成文档； SmartDoc：添加依赖和注释并执行测试类生成文档； API2DOC：添加依赖，启用注解，通过注解配置生成文档。
以上四种方式无疑都需要添加依赖、使用注解等，可以说具有一定程度的代码侵入性。 使用的接口文档工具ShowDoc：我很喜欢用这个工具一段时间。
Markdown 语法方便直观。但你必须自己写； YApi：现在使用YApi，可以通过Swagger导入； VS Code 编写 Markdown：直接离线编写 Markdown，可以导出 PDF、Word、Html。
自己写文档既重复又繁琐，但我个人更喜欢Markdown格式。简单直观。
另外，配合我之前写的IDEA插件copy-as-json和Tookit，将实体复制成json字符串，可以用来快速生成请求样本和返回样本，还是可以减少一定的工作量。 其他使用方式则使用各种在线协作工具，如腾讯文档、语雀、石墨文档等。
使用 PDF、Word、Excel 等的离线版本。还有一些其他的文档工具，但我从未使用或研究过它们。
基本上，这些文档工具要么通过代码入侵生成文档，要么手动生成文档。一般来说，各有各的优点。
个人手写更方便。就我个人而言，我更喜欢手写 Markdown。
下面是两张图： ShowDoc 官方示例 VS Code 手写文档 有时候文档多了，写起来就累了。特别是最近使用了YApi，个人觉得使用Swagger然后导入到YApi还是蛮方便的，省时省力。
后来我想，既然YApi提供了接口，那我是不是可以自己生成一下，然后传给YApi呢？于是我开始开发这个插件。 2、既然最基本的版本用法和功能都已经开发出来了，当然有必要介绍一下。
首先看图： Doc View样例通过图简单介绍了用法和功能： 使用方法很简单，直接在Controller类或者Controller类的public非静态方法中右键，弹出菜单，独立的文档视图就足够了。只能在 Controller 类或 Controller 类的公共非静态方法中使用。
至于两者的区别，稍后会介绍。这里有的朋友可能会有疑问：Dubbo接口不可以写文档吗？嗯~好吧！不过现在不支持啦~基本功能如截图所示。
左侧显示接口名称和列表，右侧显示接口信息；点击复制按钮会将显示信息对应的Markdown文本复制到剪贴板；在Class内部点击生成如图所示的列表，并且在方法内右键只生成这个方法。 使用说明 目前版本不支持Dubbo接口，所以下面介绍的都是Class的使用： 生成文档需要满足什么条件？目标类内部有方法；该类必须有相关的 Spring 注解。
org.springframework.stereotype.Controllerorg.springframework.web.bind.annotation.RestController 生成文档。接口方法需要满足什么条件？文档方法：公共修饰和非静态方法（静态修饰），该方法包含以下注解：org.springframework.web.bind.annotation.GetMappingorg.springframework.web.bind.annotation.PostMappingorg.springframework.web.bind。
注释.GetMappingorg.springframework.web.bind.annotation.DeleteMappingorg.springframework.web.bind.annotation.PatchMappingorg.springframework.web.bind.annotation.RequestMapping文件模板可以设置吗？当前版本的文档模板只有所示的，不支持自定义模板。接口名称如何设置？接口名称默认值如图：类名#方法名；支持在注释上使用@name来设置接口名称。
你从哪里得到接口描述？接口描述直接拿方法注解；如果有@description标签，则优先使用该标签对应的描述。请求路径是如何生成的？采取类和方法上的路径来组装它。
如何设置请求方式？根据方法上的注释生成。请求参数和请求示例需要设置什么？根据是否有@RequestBody注解，生成的请求头是json还是form。
同时会检测请求参数中是否有@RequestHeader注解；生成 Header 对象的列表；根据请求是json还是form生成相应的请求示例。如何生成返回参数和返回示例？支持对象，返回空，用泛型方法返回。
这里的泛型仅支持名为 T 的单个泛型类型。泛型回归 3 总结问答：Doc View 插件在哪里下载？ A：可以直接通过IDEA插件仓库搜索名称；通过 GitHub 上的 Releases 下载；关注公众号，发送Doc View相关关键词（doc/doc view）即可获取。
问：Doc View 是开源的吗？答：是的。开源地址在文章最后。
如果您有兴趣，可以给它一个star。如果你想添加一些功能，也可以提出 PR。
结论 插件开发从最初的开发到今天发布第一个版本花了很长时间。毕竟只是业余时间开发的，所以断断续续的写了一下，不过现在最简单的版本已经可以使用了。
目前复印功能只有一项，但基本够用了。至于其他需求，比如：自定义模板、支持Dubbo接口、预览导出等功能，未来还需要迭代。
个人的发展精力是有限的。小伙伴们在使用过程中肯定会遇到bug，或者有其他的功能和使用建议。
您可以通过以下方式反馈： 关注公众号：“刘志航”，通过读者讨论留言；在 GitHub 上提交问题；在插件帮助页面留言；请在文末留言。
版权声明：本文内容由互联网用户自发贡献，本站不拥有所有权，不承担相关法律责任。如果发现本站有涉嫌抄袭的内容，欢迎发送邮件 举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。
标签：
相关文章
06-18
06-17
06-18
06-06
06-17
06-17
06-17
06-08
最新文章
【玩转GPU】ControlNet初学者生存指南
【实战】获取小程序中用户的城市信息（附源码）
包雪雪简单介绍Vue.js：开学
Go进阶：使用Gin框架简单实现服务端渲染
线程池介绍及实际案例分享
JMeter 注释 18 - JMeter 常用配置组件介绍
基于Sentry的大数据权限解决方案
【云+社区年度征文集】GPE监控介绍及使用