用java代码生成swagger文档_Java 零注解文档生成工具—smart-doc,看完有替换swagger的冲动...

smart-doc是一个基于Java源码分析的RESTful API文档生成工具,无需注解侵入,只需标准注释即可生成Markdown、Html等文档。相比swagger,smart-doc更注重零注解和低侵入,支持多种格式输出,并提供丰富的配置选项。适用于厌倦了swagger注解的开发者。
摘要由CSDN通过智能技术生成

Tips:喜欢的话可以关注小萌哦~~~

今天小萌给大家推荐的一个开源Java Restful API 文档生成工具,一加【oneplus】、iflytek都在用。所以,自然差不了。

官方简介

smart-doc 是一个 java restful api 文档生成工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写,smart-doc 就能帮你生成一个简易明了的 Markdown、Html、AsciiDoc 文档。

如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污染,smart-doc是不错的选择!

最新版本

smart-doc 1.7.7

修改timestamp类型字段创建json示例错误bug。

fix #I1545A 单接口多路径bug。

修改部分url生成部署空格问题。

优化对java.util.concurrent.ConcurrentMap的解析。

开源地址

快速入门

1、Getting started

https://gitee.com/sunyurepository/api-doc-test.git

你可以启动这个Spring Boot的项目,然后访问http://localhost:8080/doc/api.html来浏览smart-doc生成的接口文档。

2、Dependency

com.github.shalousun

smart-doc

1.7.7

test

3、Create a unit test

通过运行一个单元测试来让Smart-doc为你生成一个简洁明了的api文档。

public class ApiDocTest {

/**

* 包括设置请求头,缺失注释的字段批量在文档生成期使用定义好的注释

*/

@Test

public void testBuilderControllersApi() {

ApiConfig config = new ApiConfig();

config.setServerUrl("http://localhost:8080");

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值