大家好,今天来为大家分享doc网站源码分享的一些知识点,和网页源码网站的问题解析,大家要是都明白,那么可以忽略,如果不太清楚的话可以看看本篇文章,相信很大概率可以解决您的问题,接下来我们就一起来看看吧!
介绍
smart-doc是一款同时支持JAVARESTAPI和ApacheDubboRPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念,完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。
你只需要按照java-doc标准编写注释,smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman、Collection2.0+、OpenAPI3.0+的文档。
特点
零注解、零学习成本、只需要写标准JAVA注释。
基于源代码接口定义自动推导,强大的返回结构推导。
支持SpringMVC、SpringBoot、SpringBootWebFlux(controller书写方式)、Feign。
支持Callable、Future、CompletableFuture等异步接口返回的推导。
支持JavaBean上的JSR303参数校验规范,包括分组验证。
对JSON请求参数的接口能够自动生成模拟JSON参数。
对一些常用字段定义能够生成有效的模拟值。
支持生成JSON返回值示例。
支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
支持生成多种格式文档:Markdown、HTML5、Asciidoctor、PostmanCollection、OpenAPI3.0。Up-开放文档数据,可自由实现接入文档管理系统。
支持导出错误码和定义在代码中的各种字典码到接口文档。
支持Maven、Gradle插件式轻松集成。
支持ApacheDubboRPC接口文档生成。
debug接口调试html5页面完全支持文件上传,下载(@downloadtag标记下载方法)测试。
Smart-doc从2.0.0后几乎实现了swaggerui的功能,并且比swaggerui更简洁大方,也更符合国内开发者的诉求。
当然smart-doc本身是只支持扫描代码生成openapi3.0的文档的,也可以将生成的openapi3.0文档导入到其他ui中渲染展示。另外,欢迎关注公众号Java笔记虾,后台回复“后端面试”,送你一份面试题宝典!
效果示例
1.1接口文档效果图
请求参数示例
响应参数示例
1.2htm
关于本次doc网站源码分享和网页源码网站的问题分享到这里就结束了,如果解决了您的问题,我们非常高兴。