SpringBoot 基于SpringFox Swagger REST API文档自动生成

本文档介绍了如何在SpringBoot项目中利用SpringFox Swagger自动化生成REST API文档,包括maven配置、Swagger2初始化、Controller配置,并展示了Swagger-UI的使用,帮助开发者减少接口文档编写的工作量。
摘要由CSDN通过智能技术生成

SpringBoot 基于SpringFox Swagger REST API文档自动生成 


                  一、maven 配置

二、初始化Swagger2的配置

三、Controller的配置

四、启动项目查看Swagger-UI

五、直接通过Swagger UI 调用接口


 

感觉有一阵子都没有写博客了,因为工作比较忙也有一段时间没有去更新了。希望过年休息这段时间能好好分享一下,这2018年发现了什么好东西,或者开发了什么好东西。

先热热身写个篇幅没有那么长的,相信很多平台现在已经前后端彻底分离了,少不免后台的开发同学还要天天写接口文档,本人是非常讨厌这种重复无趣的工作,所以我也写了很多去除反复工作的东西,例如映射深拷贝、无配置动态认证权限框架、动态错误消息参数校验框架、DDL Createor插件(PS:上一遍文章有体积,升级了几个版本也没有更新出来,我的错!!!)等。甚至通过python 写了一个通过第三方接口文档生成请求和返回的JAVA实体工具,所以自动生成API文档也在我在我的计划开发范围之内。但是巧了,Swagger 正是实现了这些,甚至实现的相当好(PS:不能定义模板去生成对应的文档格式,这个有时间可以扩展一下)。今天就来聊聊SpringFox-Swagger

首先贴出这个开源项目的地址:https://github.com/springfox/springfox

比较不幸的是,项目的主页打不开,看不到官网文档!!!http://springfox.github.io/springfox/

先看看使用之后生成的文档长啥样:

看到这里你应该觉得  ~嗯···· 可以起码能够表达接口功能的意义了

那就看看什么配置实现文档自动生成吧

一、maven 配置

<dependencies>       
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值