java+swagger+侵入,一种无侵入比swagger-ui兼容性更好更简单的API文档生成方案

一种无侵入比swagger-ui兼容性更好更简单的API文档生成方案

作者：互联网活化石

来源：http://suo.im/5Sijti

在后端项目中，难免遇到需要写接口文档方便第三方调用的场景，一般业界最常用的方案是使用swagger。Java项目中，一般采用springfox项目，它集成了swagger和swagger-ui，不需要单独部署项目，可让文档随着项目一起发布。

为什么不使用swagger-ui

但是开源项目往往是开源一时热，事后拂衣去，缺少维护。这个项目已经两年多没有维护了，很多人在issue反馈过bug，作者一年前表示自己比较忙，没空维护。

springfox最新的版本是2.9.2，不支持spring5(虽然有个快照版支持spring5，但一直没发布，整合也有点麻烦)。spring5比较大的一个改变就是增加了webflux，因此旧版springfox无法兼容spring5的。

其实用快照版，稍作修改也能让springfox支持webflux，但是我不是很喜欢这种做法。一个是增加了打包体积和运行内存占用，另一个则是swagger的使用污染了Java源码，很是不美观，强迫症不能忍。

@RestController

java+swagger+侵入,一种无侵入比swagger-ui兼容性更好更简单的API文档生成方案相关推荐

delphi ui编辑工具源码_一种无侵入比swagger-ui兼容性更好更简单的API文档生成方案
在后端项目中,难免遇到需要写接口文档方便第三方调用的场景,一般业界最常用的方案是使用swagger.Java项目中,一般采用springfox项目,它集成了swagger和swagger-ui,不需要 ...
一款零注解侵入的 API 文档生成工具，你用过吗？
以下文章来源方志朋的博客,回复"666"获面试宝典介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart ...
java smart算法_Java Restful API 文档生成工具 smart-doc
谁说生成api文档就必须要定义注解? 谁说生成接口请求和返回示例必须要在线? 用代码去探路,不断尝试更多文档交付的可能性. 如果代码有生命,为什么不换种方式和它对话! 一.背景没有背景.就自己做自己 ...
semantic ui中文文档_求你别再用swagger了，给你推荐几个在线文档生成神器
开局先推荐: Java面试刷题网站www.javazhiyin.com 前言最近公司打算做一个openapi开放平台,让我找一款好用的在线文档生成工具,具体要求如下: 必须是开源的能够实时生成在 ...
Java api文档自动生成工具smartdoc+torna
首先,一般做java服务端都用过postman,并且都写过前端调用的api文档接口,并且也用过市面上的一些工具. API自文档动生成,能够省去了写文档的时间. 当然,当前也会有很多类似的开源工具,我们 ...
推荐几款接口文档生成神器用来代替Swagger
前言最近公司打算做一个openapi开放平台,让我找一款好用的在线文档生成工具,具体要求如下: 必须是开源的能够实时生成在线文档支持全文搜索支持在线调试功能界面优美说实话,这个需求看起来简 ...
Spring MVC中使用Swagger生成API文档和完整项目示例Demo，swagger-server-api（二十）
一:Swagger介绍 Swagger是当前最好用的Restful API文档生成的开源项目,通过swagger-spring项目实现了与SpingMVC框架的无缝集成功能,方便生成spring r ...
java接口注释_Java的注释和API文档
Java 语言的注释一共有三种类型: 单行注释多行注释文档注释一.单行注释和多行注释单行注释就是在程序中注释一行代码,在 Java 语言中,将双斜线(//)放在需要注释的内容之前就可以了 : ...
14-网关实战：网关层整合 Swagger 聚合API文档
上节课介绍了网关层的认证鉴权,今天这节介绍一下网关层如何聚合API接口文文档. 为什么需要聚合API接口文档? 大型微服务系统模块众多,木谷博客系统就有9个,如果这些服务的接口地址没有一个统一,那么客 ...

java+swagger+侵入,一种无侵入比swagger-ui兼容性更好更简单的API文档生成方案

java+swagger+侵入,一种无侵入比swagger-ui兼容性更好更简单的API文档生成方案相关推荐

最新文章

热门文章