Apiggs —— 非侵入性的 RestDoc 文档生成工具
程序员一直以来都有一个烦恼,只想写代码,不想写文档。代码就表达了我的思想和灵魂。 Python提出了一个方案,叫docstring,来试图解决这个问题。即编写代码,同时也能写出文档,保持代码和文档的一致。docstring说白了就是一堆代码中的注释。Python的docstring可以通过help函数直接输出一份有格式的文档,本工具的思想与此类似。
代码即文档
Apiggs是一个非侵入的RestDoc文档生成工具。工具通过分析代码和注释,获取文档信息,生成RestDoc文档。
有这样一段代码
/** * Building a RESTful Web Service * 来自spring的官方示例:https://spring.io/guides/gs/rest-service/ */ @RestController public class GreetingController { private static final String template = "Hello, %s!"; private final AtomicLong counter = new AtomicLong(); /** * Web Endpoint greeting * @param name who is this * @return */ @RequestMapping("/greeting") public Greeting greeting(@RequestParam(value="name", defaultValue="World") String name) { return new Greeting(counter.incrementAndGet(), String.format(template, name)); } }
运行插件
gradle 运行 task: Tasks/documentation/apiggs
maven 运行 compile
生成文档
在编译目录下生成apiggs文件夹,并生成三个文件:
1. .json文件,可直接导入postman
1. .adoc文件,Asciidoc源文件
1. .html文件,源文件渲染结果,效果如下图
本文来自云栖社区合作伙伴“开源中国”
本文作者:王练
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
笑中带泪的码农往事:入职三天被开,公司给100块叫我走人,有我惨?
本文由作者“假不理”发表于“编程无界”公众号,现重新整理发布,感谢作者的精彩分享。 1、引言 十月,金秋季节,本是丰收之时,却因为陆续有同事离职,心中多少有些悲凉之意,顿然想起从参加工作到现在。至今五年已过,当年青涩懵懂的小年轻,如今出街招摇过市时,被小孩子看到都会喊声大叔。 回想这五年,有心酸和无奈、有快乐和期待、也有不断的蜕变和成长。趁着国庆长假,写下这一路的心路历程,于己,是一个总结和督促,于读者,是一个故事,兼听则明,希望对你们有些许启发,足矣。 本文内容是据笔者的亲身经历和体会写就,虽然我比任何人都希望它只是些段子,但偏偏都是真事。一念之下发此文,不为名不为利,只愿与君共勉! (本文同步发布于:http://www.52im.net/thread-2030-1-1.html) 2、毕业=失业?有可能的 2013年6月底,虽然此前早已被某软(国内最大的软件开发商)的政府事业部录用并被寄以厚望要培养成核心人员,但出于对乡土的眷恋和对南方的热爱,还没领到毕业证的我,怀着极大的憧憬,拖着一个行李箱,兜里怀揣着几百块钱,坐了三十多个小时的绿皮从山东回到广州。 “初来乍到,请多多指教”,...
- 下一篇
windows编辑好的python代码在linux的vim编辑,缩进问题
vim test.py :set paste 回车 按键 insert 粘贴代码
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- SpringBoot2整合MyBatis,连接MySql数据库做增删改查操作
- CentOS8安装MyCat,轻松搞定数据库的读写分离、垂直分库、水平分库
- SpringBoot2整合Thymeleaf,官方推荐html解决方案
- Mario游戏-低调大师作品
- 2048小游戏-低调大师作品
- SpringBoot2初体验,简单认识spring boot2并且搭建基础工程
- 设置Eclipse缩进为4个空格,增强代码规范
- Windows10,CentOS7,CentOS8安装Nodejs环境
- MySQL8.0.19开启GTID主从同步CentOS8
- Docker快速安装Oracle11G,搭建oracle11g学习环境