java restful api文档生成工具smart-doc(1)

最新推荐文章于 2024-06-05 18:29:28 发布
最新推荐文章于 2024-06-05 18:29:28 发布
阅读量313 收藏
点赞数
文章标签： smart-doc restful api
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ls_call520/article/details/103915317
版权

1、pom中引入start-doc包

2、新建测试相关类：

目录结构：

3、新建java类SmartDocUtil.java

4、下载markdown工具：typora-setup-x64.exe

网址：https://www.typora.io/#windows

5、安装，运行.md相关文件，结果如图：

 

 

I.T10001
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
SpringBoot集成smart-doc和torna接口文档的自动创建与文档推送
08-03
smart-doc和torna接口文档的自动创建与文档推送，解决了后端维护接口文档的困扰，没有swagger代码倾入性强，简单易上手，替代postman支持在线调试接口，超简单的集成Demo，下载即可用
java 自己的doc文件生成 api说明文档工具
08-05
同时，它指出现在已经更多地使用Swagger，这是一个流行的API文档生成工具，特别适用于RESTful API的文档编写。Swagger提供交互式的UI，使得用户可以直接在文档中尝试API调用，增强了用户体验。 标签"javaDoc to chm...
smart-doc Java Restful API 文档生成工具
liqyun的博客
04-19 437
smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，还支持接口在线调试。 不用依赖任何注解，不会像swagger一样需要写很多繁琐的注解 使用教程 在pom文件中引入插件 <plugin> <groupId>com.github.shalousun</groupId> <artifactId>smart-doc-maven-plugin</artifactId..
smart-doc使用说明
最新发布
weixin_43281011的博客
06-05 1101
仅做配置，并不生效<build><plugins>-- smart-doc插件 --><plugin>--指定生成文档的使用的配置文件-->--指定项目名称--><projectName>商城项目</projectName><goals>--smart-doc提供了html、openapi、markdown等goal，可按需配置--></goals>
SpringBoot 集成 Smart-Doc
javaTalk
07-24 5132
一 什么是 Smart-Doc smart-doc 是一个 java restful api 文档生成工具，smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要按照 java 标准注释的写，smart-doc就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强...
SpringBoot接口 - 如何生成接口文档之集成Smart-Doc
DeveloperFire的博客
03-16 1661
smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念， 完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。你只需要按照java-doc标准编写注释， smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman Collection2.0+、OpenAPI 3.0+的文档。零注解、零学习成本、只需要写标准JAVA注释。
smart-doc初体验-springboot生成自动文档
热门推荐
qq_31564573的博客
05-06 1万+
smart-doc 使用体验
集成smart-doc插件零侵入自动生成RESTful格式API文档.zip
08-26
Smart-doc是一个Java工具，它可以零侵入地集成到Spring Boot应用中，自动从源代码中提取API信息并生成高质量的文档。"零侵入"意味着开发者无需在代码中添加额外的注解或配置，而是智能地分析已有的Spring MVC注解...
smart-doc-team-smart-doc-master_java_
09-29
**标题解析：** ...综上所述，"smart-doc"是一个针对Java开发者设计的实用工具，能够方便地处理RESTful API和Apache Dubbo服务的文档生成，使得开发者可以更专注于代码的编写，而无需花费大量时间在文档维护上。
apiDoc:RESTful Web API 文档生成器-开源
08-07
没有任何参数，apiDoc 从当前目录（包括子目录）中的所有 .cs .dart .erl .go .java .js .php .py .rb .ts 文件生成文档并将输出写入 ./doc/。 apiDoc 包含一个默认模板，它使用把手、Bootstrap、RequireJS 和 ...
api-doc:Java开发工具，自动生成api文档
05-11
api-doc 文档生成工具 java开发，根据代码自动生成api接口文档工具，支持RESTful风格 预览版 该工具的优势 文档自动生成，减少文档维护的时间和成本 支持复杂的接口请求参数或响应参数，比如对象的多层、互相嵌套 ...
javaapi源码-smart-doc:Smart-doc是JavaRestfulapi文档生成工具。Smart-doc基于接口源代码分析来生
05-19
java api源码智能文档项目 介绍 smart-doc是同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具。 Smart-doc基于接口源代码分析来生成接口文档，并实现零注释入侵。 您只需在开发时编写Javadoc注释，智能文档即可帮助您生成Markdown或HTML5文档。 smart-doc不需要像Swagger这样的代码中添加注解。 特征 零注释，零学习成本，只需要编写标准的JAVA文档注释。 基于源代码接口定义的自动派生，强大的返回结构派生支持。 支持Spring MVC，Spring Boot，Spring Boot Web Flux（不支持端点），Feign。 支持派生异步接口返回值，例如Callable，Future，CompletableFuture。 支持JSR-303参数验证规范。 支持基于请求参数自动生成请求示例。 支持生成JSON返回值示例。 支持从项目外部加载源代码以生成字段注释（包括源jar包）。 支持生成多种格式的文档：Markdown，HTML5，Asciidoctor，Postman Collection 2.0
SpringBoot 集成smart-doc插件零侵入自动生成RESTful格式API文档
蓝天
01-13 2319
一、简介（摘要） smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念， 完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。你只需要按照java-doc标准编写注释， smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman Collection2.0+、OpenAPI 3.0+的文档。 二、特点（摘要） 零注解、零学习成...
SpringBoot——SpringBoot生成接口文档
庄小焱
03-30 6992
SpringBoot开发Restful接口，有什么API规范吗？如何快速生成API文档呢？Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲，Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并且可以进行接口调用和测试的服务。本文主要介绍OpenAPI规范，以及Swagger技术栈基于OpenAPI规范的集成方案。
smart-doc详细完整使用教程
dgywj的专栏
03-23 3497
smart-doc的使用教程，能成功生成文档
smart-doc 文档生成器实战
HarryChenj的专栏
12-12 958
smart doc，使用文档、说明文件、帮助文件等文档生成器
神器 SpringDoc 横空出世！最适合 SpringBoot 的API文档工具来了！
weixin_42907150的博客
02-29 1551
SpringDoc是一款可以结合SpringBoot使用的API文档生成工具，基于OpenAPI 3，目前在Github上已有1.7K+Star，更新发版还是挺勤快的，是一款更好用的Swagger库！值得一提的是SpringDoc不仅支持Spring WebMvc项目，还可以支持Spring WebFlux项目，甚至Spring Rest和Spring Native项目，总之非常强大，下面是一张SpringDoc的架构图。
SpringBoot 生成接口文档，集成接口文档工具smart-doc（文末福利）
王不困的博客
03-30 1200
在前后端分离项目中我们一般需要在请求接口时设置一个请求头，如token，Authorization等...后端根据请求头判断是否为系统合法用户，目前smart-doc也对其提供了支持。在smart-doc配置文件"requestHeaders": [ //设置请求头，没有需求可以不设置"name": "token",//请求头名称"type": "string",//请求头类型"desc": "自定义请求头 - token",//请求头描述信息。
【SpringBoot框架篇】23.集成smart-doc插件零侵入自动生成RESTful格式API文档
皓亮君的博客
10-18 2381
文章目录简介1.配置准备1.1添加maven插件1.2 创建配置文件1.3 添加统一返回数据格式类2.接口实战2.1 demo接口类2.2 用户模型类2.3相关注释描述2.3.1 接口名称2.3.2 接口参数2.3.2.1 @PathVariable和@RequestParam2.3.2.2 @RequestBody2.3.2.3模型类相关注释3.文档生成并查看3.1生成文档命令3.2查看4.集成torna统一管理和测试API文档4.1创建空间并找到3要素(appKey,secret,appToken)4.
RESTful Java实战：基于JAX-RS
《RESTful Java with JAX-RS》是由Bill Burke撰写的一本关于RESTful服务开发的书籍，主要关注使用Java API for RESTful Web Services (JAX-RS) 实现RESTful架构风格的Web服务。这本书详细介绍了如何在Java环境中构建...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值