smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念， 完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。你只需要按照java-doc标准编写注释， smart-doc就能帮你生成一个简易明了的Markdown、Postman Collection2.0+、OpenAPI 3.0+的文档。除此之外smart-doc还支持生成漂亮简洁可调试的html5页面文档。
功能特性
- 支持生成可直接调试接口的文档页面(文件上传、下载也支持)。
- 零注解、零学习成本、只需要写标准java注释。
- 基于源代码接口定义自动推导，强大的返回结构推导。
- 支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller书写方式)、Feign。
- 支持Callable,Future,CompletableFuture等异步接口返回的推导。
- 支持JavaBean上的JSR303参数校验规范、支持分组校验。
- 对json请求参数的接口能够自动生成模拟json参数。
- 对一些常用字段定义能够生成有效的模拟值。
- 支持生成json返回值示例。
- 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
- 支持生成多种格式文档：Markdown、HTML5、Asciidoctor、Postman collection 2.0+、Open Api 3.0 +。
- 轻易实现在Spring Boot服务上在线查看静态HTML5文档，支持debug调试接口。
- 开放文档数据，可自由实现接入文档管理系统。
- 支持生成Postman Collection数据一键到入到Postman测试接口，参数值默认帮你填好。
- 从1.8.0版本全面支持json和表单请求解析。
- 一款代码注释检测工具，不写注释的小伙伴逃不过法眼了。
- 支持导出错误码和定义在代码中的各种枚举字典码到接口文档。
- Maven、Gradle插件化支持，使用极其简单（推荐使用插件）。
- Apache Dubbo RPC接口文档生成支持。
- JAX-RS支持
官方推荐方案
smart-doc + Torna 组成行业领先的文档生成和管理解决方案，使用smart-doc无侵入完成Java源代码分析和提取注释生成API文档，自动将文档推送到Torna企业级接口文档管理平台
知名用户
-
一加【oneplus】
-
科大讯飞
-
小米
-
同程旅行
-
马蜂窝
-
东软
-
汉得信息
Markdown工具推荐
smart-doc目前能够支持将文档合并到一个Markdown文件，因此你可以使用Typora工具将Markdown转换成pdf、word或者是html文档。
相关文档
smart-doc官方wiki：https://gitee.com/smart-doc-team/smart-doc/wikis/Home
Demo
demo地址：https://gitee.com/smart-doc-team/smart-doc-example-cn.git
-
使用注释生成文档 官网：https://github.com/smart-doc-group/smart-doc 文档地址：https://smart-doc-group.github.io/#/start/javadoc 1.最新依赖 <plugin> <groupId>com.github.shalousun</groupId> <artifactId>smart-doc-ma
-
代码规范 smart-doc通过对javadoc注释的源码就行分析，生成html接口文档，然后将文档推送到torna统一展示。故对于代码规范要求很严格。 1.JavaDoc规范。添加类、方法注解 标签 描述 示例 @author 标识一个类的作者 @author description @exception 标志一个类抛出的异常 @exception exception-name explanat
-
本文向大家介绍Python文档生成工具pydoc使用介绍，包括了Python文档生成工具pydoc使用介绍的使用技巧和注意事项，需要的朋友参考一下 在Python中有很多很好的工具来生成字符串文档(docstring)，比如说: epydoc、doxygen、sphinx，但始终觉得pydoc还是不错的工具，用法非常简单，功能也算不错，本文主要介绍pydoc. pydoc是Python自带的模块，
-
https://github.com/estan/protoc-gen-doc 这是一个Google Protocol Buffers编译器(protoc)的文档生成插件。这个插件可以从.proto文件中的注释内容生成HTML, DocBook 或者 Markdown 文档。 安装 参考 protoc-gen-doc Installation章节的信息。 linux安装 对于ubuntu系统，参考
-
easyopen提供一个简单的api文档查看页面，类似于swagger，基于注解功能来生成文档页面。生成的文档页面可以查看参数、结果说明，也可以进行模拟请求。对于前后端分离的项目来说会很有帮助。文档界面如下图所示： 左边的树形菜单对应文档名称，点击树可前往查看对应的接口说明。点击请求按钮可以发起请求进行测试。可修改业务参数中的值进行测试。 下面来讲解文档注解的使用方法。 文档页面默认是关闭的，需要
-
CabalPHP 支持接口文档自动生成。 编写好相关配置和文档注释后浏览器访问 http://127.0.0.1:9501/__docs 即可查看相关文档，注意检查自己的监听端口和IP。 点击这里访问示例文档 接口文档地址只能在debug环境（cabal.debug配置为true）下访问。 配置 文档相关配置在 conf/cabal.php // ... 'document' =
-
支持在项目中使用 Swagger 注解语法，运行命令，生成 Swagger 文件。 Swagger 是最流行的 API 开发工具，它遵循 OpenAPI Specification（OpenAPI 规范，也简称 OAS）。 Swagger 可以贯穿于整个 API 生态，如 API 的设计、编写 API 文档、测试和部署。 Swagger 是一种通用的，和编程语言无关的 API 描述规范。 imi-
-
Django的admindocs应用从模型、视图、模板标签以及模板过滤器中，为任何INSTALLED_APPS中的应用获取文档。并且让文档可以在Django admin中使用。 在某种程度上，你可以使用admindocs来快为你自己的代码生成文档。这个应用的功能十分有限，然而它主要用于文档模板、模板标签和过滤器。例如，需要参数的模型方法在文档中会有意地忽略，因为它们不能从模板中调用。这个应用仍旧有
-
原有插件生成的 HTML 文件内容和格式并不理想，考虑自行调整。 因此 fork 了原有仓库，准备动手修改。 这样就有必要能自己从c的源代码开始编译打包。 参考原有的插件打包说明： https://github.com/skyao/protoc-gen-doc/blob/master/BUILDING.md 准备工作 按照要求，需要准备两个东西： Protocol Buffers library
-
安装 protoc-gen-doc 简单遵循安装要求即可： https://github.com/estan/protoc-gen-doc 安装完成之后的protoc是2.5.0版本，无法处理proto3的文件。因此我们需要升级替换protoc为v3.0.0版本。 升级protoc 使用预编译版本 下载 请先在 protobuf 的 发布页面 中找到对应版本的 download ，然后下载对应版本