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

smart-doc接口文档生成工具

Part1文章首推 支付宝接口对接 高德地图调用 验证码登录 QQ邮箱登录 Part2今日主题:smart-doc接口文档生成工具 这个一个接口生成文档工具,之前我也有推荐swagger这款工具,但是这款工具在生产环境中却不怎么用...,对代码的侵入性太高了,现在来介绍一下smart-doc这款接口文档工具吧,他可以识别javadoc注释然后生成文档,也就是说只要你采用正常的注释就好了。...RequestMapping("/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界面,也可以设置为中文: ?...最终还是去看官方文档,终于发现了官方的sample。针对于各种option的操作完全在demo中了,所以clone照抄就可以用了。

2.6K20
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

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

    初衷 记得以前写接口,写完后会整理一份API接口文档,而文档的格式如果没有具体要求的话,最终展示的文档则完全决定于开发者的心情。也许多点,也许少点。...甚至,接口总是需要适应新需求的,修改了,增加了,这份文档维护起来就很困难了。于是发现了swagger,自动生成文档的工具。...swagger会扫描配置的API文档格式自动生成一份json数据,而swagger官方也提供了ui来做通常的展示,当然也支持自定义ui的。不过对后端开发者来说,能用就可以了,官方就可以了。...效果为先,最终展示doc界面,也可以设置为中文: ?...return new ResponseEntity(new BaseResponse(result,true,null), HttpStatus.OK); } } 4.设定访问API doc

    2.3K100

    告别手写,使用 Doc View 快速生成接口文档

    Doc View 是一款快捷生成接口文档 IDEA 插件,使用 Doc View 可以将开发人员从繁琐的文档编写中释放出来,极大的节省开发时间。...Doc View 支持以下功能: Controller/Dubbo 接口生成 Markdown 文档 查看 Markdown 源码,预览 Markdown, 编辑接口字段等 支持自定义配置 Markdown...1生成文档 可以通过在右键菜单或者点击左侧导航栏的M 进入展示界面。 界面可以:导出全部、上传全部、预览、查看 MD 源文件、编辑、单文件上传等。...GitHub:https://github.com/liuzhihang/doc-view 插件文档是放在语雀,方便留言、划词留言等,也欢迎共同维护。...说明文档:https://www.yuque.com/liuzhihangs/doc-view 在说明文档中有更详细的使用哦!

    1K20

    ES文档文档操作_doc(7.9.2)

    _type": 在Elasticsearch 7.x版本之后,通常为"_doc",表示默认文档类型。"_id": 这是文档的唯一标识符,用于在索引中唯一标识文档。在这里,文档的ID是"1"。"...GET goboy-blog/_doc/1查看索引中所有文档内容GET goboy-blog/_search判断文档是否存在根据id判断指定文档是否存在Head goboy-blog/_doc/1Head...添加字段增加一个文档的字段tags并为其赋值增加tags标签并为其赋值 java,jsPUT goboy-blog/_doc/2{ "title":"我的第二个文档", "data":"2023-11..._source.tags=[\"java\",\"js\"]" }}获取文档内容:使用add方法为tags标签添加一个元素cssPOST goboy-blog/_update/2{ "script"...删除文档根据id删除语法:DELETE {index}/_doc/{id}删除一个id为 VF9xiosBWWxO5_dDHEpm 的文档DELETE goboy-blog/_doc/VF9xiosBWWxO5

    62730

    Python __doc__属性:查看文档

    CLanguage 成员的具体信息help(my_package.module2.CLanguage) 值得一提的是,之所以我们可以使用 help() 函数查看具体成员的信息,是因为该成员本身就包含表示自身身份的说明文档...前面讲过,无论是函数还是类,都可以使用 __doc__ 属性获取它们的说明文档,模块也不例外。...以 my_package 包 module1 模块中的 display() 函数为例,我们尝试用 __doc__ 变量获取其说明文档: import my_package print(my_package.module1...__doc__) 程序执行结果为:     直接输出指定的参数 其实,help() 函数底层也是借助 __doc__ 属性实现的。...); 对于非自定义的模块或者包,可以查阅 Python 库的参考文档 https://docs.python.org/3/library/index.html。

    1.1K00

    腾讯文档Doc Canvas渲染引擎流程改造

    为了解决部分历史渲染问题,实现移动端canvas渲染的新功能,以及支持后续功能扩展,对腾讯文档Doc Canvas渲染引擎的流程进行了改造,本文对改造进行介绍和小结。1. 改造背景1.1....解决历史问题Doc文档滚动过程中偶现渲染空白(safari浏览器出现频率较高):图片1.2....渲染层基本流程介绍渲染层(Render Engine)最基本的能力就是将上层排版层生成文档视图树形结构LayoutBox进行收集和渲染,最终将文档视图呈现在屏幕上,示意图如下图所示:图片而要详细说明渲染层的收集和渲染流程...,需要先简单介绍LayoutBox,如下图所示,LayoutBox是腾讯文档Doc经过排版后生成的用于描述文档页面信息的树形结构,不同类型的box表示文档中不同的层级和内容:图片渲染层收集的目的,就是通过可视区域等信息判断并计算出需要渲染的文档区域...Doc文档的滚动实际非常类似,且分页模式下排版结构中分页LogicPage和item可以天然对应起来:图片分页渲染将每次渲染和复用的最小单位固定为文档的分页(对应排版结构LogicPage),滚动过程中仅仅需要对出现在渲染区域的新分页进行渲染

    4.8K130

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

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

    5.5K30

    Python常用函数--文档字符串Doc

    令人惊叹的是,当程序实际运行时,我们甚至可以通过一个函数来获取文档!...__doc__) 输出: $ python function_docstring.py 5 is maximum 打印两个数值中的最大数。...5在此强烈建议你在你所有重要功能的所有文档字符串中都遵循这一约定。 我们可以通过使用函数的 __doc__(注意其中的双下划綫)属性(属于函数的名称)来获取函数 print_max 的文档字符串属性。...如果你曾使用过 Python 的 help() 函数,那么你应该已经在python教程中了解了文档字符串的用途了。它所做的便是获取函数的 doc 属性并以一种整洁的方式将其呈现给你。...自动化工具可以以这种方式检索你的程序中的文档。因此,我强烈推荐你为你编写的所有重要的函数配以文档字符串。

    1.1K10

    DOC文档注释,让你的代码如此清晰。

    那就想想怎么用doc文档注释自动生成接口文档了。本来以前对这一块有点印象,但是并不熟悉,加上没有很强烈的要去使用的意图,所以一直没有弄。今天要感谢公司的大神,大家都叫他欧神,神一样的男人。...Javadoc command:执行doc文档注释的命令,也可以在cmd窗口中输入这个命令 Select types for which Javadoc will be generated:要生成文档注释的项目...2.4点击完成 然后去2.1步骤中生成doc路径下打开index.html就可以看到doc文档了,成果如下: ?...3.doc注释 3.1多行注释 对于属性,方法,类的注释必须使用多行注释,单行注释不会生成文档中 3.2属性注释: /** 员工ID */ private String workerId; 3.3方法注释...,具体区别使用一次之后就一目了然了,同时@see和@link后面的对象也是需要导包的,不导包的话就使用全局限定名,如@see java.util.List 当然,还可以加入自己定义的一些注解,这些注解要生成文档注释中就要在如上图的

    1.5K40

    Go语言实战笔记(三)| Go Doc 文档

    在Go语言中,Go为我们提供了快速生成文档以及查看文档的工具,让我们可以很容易的编写查看文档。...Go提供了两种查看文档的方式,一种是使用go doc命令在终端查看,这种适用于使用VIM等工具在终端开发的人员,它们不用离开终端,既可以查看想查看的文档,又可以编码。...http://127.0.0.1:6060/pkg/会和官网不一样,你自己启动的这个服务,是基于你电脑上GOROOT和GOPATH这两个路径下的所有包生成文档,会比官网只是标准库的文档要多。...生成自己的文档 Go文档工具,还有一个亮点,就是可以支持开发人员自己写的代码,只要开发者按照一定的规则,就可以自动生成文档了。...在我们编码中,文档就是注释,Go语言采用了和C、Java差不多的注释风格。一种是双斜线的方式,一种是斜线和星号的方式。

    1.2K30

    Java模板生成word文档POI生成Excel【面试+工作】

    Java模板生成word文档/POI生成Excel【面试+工作】 ?...java后台利用模板生成Word文档提供前台下载 ---- 首先要指出的是,实现的思路和freeMarker差不离,将.doc文档做相应的转换后转为.ftl文档,其中的变量会以${xxx}来代替,这样就可以...如果还是比较传统的话,就像那个链接里的项目一样,把jar包导入项目吧 2.依据模板动态生成word文档,首先你得有个模板 模板是doc类型就好,注意不是docx,docx没有尝试,doc类型已经满足了我的需求...,朋友们如果尝试成功了可以告诉我一下 test.doc,注意“产品品质证明书”是一张图片哦,图片会漂亮的留在生成的新文档中。...8.可以运行试试看啦,给你看我生成的新文档 ? java后台利用Apache poi 生成excel文档提供前台下载 ---- Apache poi。

    3.8K20
    领券