前言Smart-Doc是一款强大的文档生成工具，可以帮助开发者轻松地为Java项目生成清晰、详细的API文档。

smart-doc是一款同时支持JAVARESTAPI和ApacheDubboRPC接口文档生成的工具，smart-doc利用接口泛型和javadoc注释自动分析生成api接口文档，不采用任何注解侵入到业务代码中

文章目录1.OpenAPI规范2.Swagger:接口管理的利器3.Swagger与SpringFox：理念与实现4.Swagger与Knife4J：增强与创新5.案例：SpringBoot整合Swagger35.1引入Swagger3依赖包5.2优化路径匹配策略兼容SpringFox5.3配置Swagger5.4Swagger配置类5.5Swagger常用注解5.6Controller5.7Sp

文章目录1.简介2.配置准备2.1添加maven插件2.2创建配置文件2.3添加统一返回数据格式类3.接口实战3.1demo接口类3.2用户模型类3.3相关注释描述4.文档生成并查看4.1生成文档命令4.2查看5.集成torna统一管理和测试API文档5.1创建空间并找到3要素(appKey,secret,appToken)5.2在smart-doc.json中添加三要素5.3推送文档到torna

API文档自动生成背景smart-doc配置效果图背景对于API接口文档自动生成，可能大家，最新想到的是用swagger，但是有以下问题：对代码侵入太强版本升级，并不兼容不能生成各种类型的文档所以，今天给大家推荐一种新的框架

本文主要介绍非侵入式的方式及集成Smart-doc案例。我们构建知识体系时使用Smart-doc这类工具并不是目标，而是要了解非侵入方式能做到什么程度和技术思路。

Smart-doc优点：1.非侵入式生成接口文档2.减少接口文档的手动更新麻烦&保证了接口文档和代码的一致3.随时可生成最新的接口文档4.保持团队代码风格一致:smart-doc支持javadoc，必须按照这个才能生成有注释的接口文档最终效果

smart-doc初体验一.为什么要引入smart-doc?

以smart-doc-group/smart-doc举例，获取其c

smart-doc可选配置参考：https://smart-doc-group.github.io/#/zh-cn/diy/config1.安装IDEA插件(更为方便)2.

目录1.Swagger及OpenAPI2.Springfox&Springdoc&Smart-doc2.1Springfox2.2Springdoc2.3smart-doc2.4总结3.Springfox2集成Swagger24.Springfox3集成OAS3.05.Springdoc集成OAS3.06.Smart-doc+Springdoc集成OAS3.06.1openapi.json集成Kn

一、依赖配置根POM文件中增加Smart-Doc插件的配置，节点位置：Project-build-pluginManagement-pluginscom.github.shalousunsmart-doc-maven-plugin

本文主要介绍非侵入式的方式及集成Smart-doc案例。

文章目录1.前言2.使用流程3.使用示例3.1接口代码编写3.2引入Smart-doc插件3.3生成文档3.4接口导入Apifox4.总结1.前言相信大家在Java开发中都用过不少接口文档工具，最常见的就是

目录前言功能特性1项目中创建/src/main/resources/smart-doc.json配置文件2配置内容如下（指定文档的输出路径）3pom.xml下添加配置4运行插件5找到存放路径浏览器打开6测试结果前言smart-doc

文章目录smart-doc使用说明特殊功能支持JSR303规范支持fastjson和Jackson字段注解如：请求参数忽略（1.5+版本）参数模拟文档变更记录字段版本记录多模块配置1.ApiConfig

文章目录smart-doc介绍smart-doc特性smart-doc的最佳搭档谁在使用smart-docsmart-doc的优缺点smart-doc和swagger区别比较smart-doc的使用姿势姿势一姿势二姿势三

本文主要介绍非侵入式的方式及集成Smart-doc案例。我们构建知识体系时使用Smart-doc这类工具并不是目标，而是要了解非侵入方式能做到什么程度和技术思路。

本文主要介绍非侵入式的方式及集成Smart-doc案例。我们构建知识体系时使用Smart-doc这类工具并不是目标，而是要了解

之前经常使用Swagger来生成，最近发现一款好用的API文档生成工具smart-doc,它有着很多Swagger不具备的特点，推荐给大家。

目录swaggervssmart-docSwagger的代码侵入性比较强原生swagger不支持接口的参数分组简单罗列一下smart-doc的优点SpringBoot集成smart-doc引入依赖，版本选择最新版本新建配置文件

介绍smart-doc是一款同时支持JAVARESTAPI和ApacheDubboRPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念，完全基于接口源码来分析生成接口文档

smart-doc是一款同时支持javarestfulapi和ApacheDubborpc接口文档生成的工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。

1，基于maven项目来完成smart-doc接口文档的生成在pom.xml文件添加插件依赖com.github.shalousunsmart-doc-maven-plugin2.0.1.

Introducesmart-doc是一款同时支持JAVARESTAPI和ApacheDubboRPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念，完全基于接口源码来分析生成接口文档

2019独角兽企业重金招聘Python工程师标准>>>smart-doc从8月份底开始开源发布到目前为止已经迭代了几个版本。在这里非常感谢那些敢于用smart-doc去做尝试并积极提出建议的社区用户。

前言利用smart-doc生成一个接口文档，关于它的优点什么的就不多说了。

官方说明：smart-doc是一个javarestfulapi文档生成工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。

一、简介smart-doc介绍-创建md、html等格式的接口文档showdoc-在线API文档、技术文档工具-保存、预览接口文档，开源，可以自己部署服务-支持手动创建和上传。

一什么是Smart-Docsmart-doc是一个javarestfulapi文档生成工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。

作为开发，写接口文档一直是一个很头痛的问题，尤其在前后端分离大量盛行的当下，后端必须要为前端同事提供明确的入参出参文档，否则整个对接工作无法顺利进行，前后端的相爱相杀的大戏时常上演。笔者刚工作的那些年，swagger都还没有正式发布，对接前端和app端的文档全靠手写markdown完成。写接口文档的时间常常感jio比写代码耗费的时间还长。随着技术的进步和众多开源人的努力，近几年针对java开发的文

当然本文的重点不是介绍dubbo的使用，而是介绍如何利用smart-doc工具来生成du

smart-doc是一个javarestfulapi文档生成工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。

工具开源地址swagger2:https://swagger.io/smart-doc：https://www.oschina.net/p/smart-doc国产两者的比较swagger2和smart-doc

官方简介smart-doc是一个javarestfulapi文档生成工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。

smart-doc是一个javarestfulapi文档生成工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。

smart-doc是一个javarestfulapi文档生成工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。

如何利用smart-doc生成接口文档?