Spring boot整合Springfox生成restful的在线api文档

 更新时间:2022年03月08日 09:42:55   作者:kl  
这篇文章主要为大家介绍了Spring boot整合Springfox生成restful在线api文档,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步

Springfox是什么,有什么用?

Springfox基于Swagger,能更方便的集成到spring boot 中,Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。Swagger的目标是对REST API定义一个标准的和语言无关的接口,可让人和计算机无需访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过Swagger进行正确定义,用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似,Swagger消除了调用服务时可能会有的猜测。

Springfox官方文档:http://springfox.github.io/springfox/docs/snapshot/

Springfox的依赖

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.4.0</version>
</dependency>

Springfox的配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket demoApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("demo")
                .genericModelSubstitutes(DeferredResult.class)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(false)
                //.pathMapping("/") //根路径
                .select()
                .paths(PathSelectors.regex("/user/.*"))//筛选展示的接口,使用PathSelectors.any(),展示所有接口
                .build()
                .apiInfo(demoApiInfo())
                ;
    }
    //api信息
    private ApiInfo demoApiInfo() {
        ApiInfo apiInfo = new ApiInfo("自己平台的api",//大标题
                "swagger搭建api平台",//小标题
                "1.0",//版本
                "NO terms of service",
                "632104866@qq.com",//作者
                "这是我的技术博客站点",//链接显示文字
                "http://www.kailing.pub"//网站链接
        );
        return apiInfo;
    }
}

测试的Controll

@RestController
@RequestMapping("/user")
public class SwaggerDemoController {
    @RequestMapping(value = "/demo2",method = RequestMethod.POST)
    @ApiOperation(value="测试接口1", notes="测试接口详细描述")
    @ResponseBody
    ModelMap getDemo(@RequestBody User user) {
        ModelMap map = new ModelMap();
        map.addAttribute("userId", 111);
        map.addAttribute("userName", "kl博客");
        return map;
    }
    @ResponseBody
    @RequestMapping(value = "/demo3", method = RequestMethod.POST)
    @ApiOperation(value="测试接口2", notes="测试接口详细描述",code = 200,produces = "application/json")
    public ModelMap getDemoa(@RequestParam("name") String demoName, @RequestParam String content) {
        ModelMap map = new ModelMap();
        map.addAttribute("result",demoName + "AAA");
        return map;
    }
    @ResponseBody
    @ApiIgnore //使用这个注解忽略这个接口
    @RequestMapping(value = "/demo4", method = RequestMethod.POST)
    public ModelMap getDemob(@RequestParam String content) {
        ModelMap map = new ModelMap();
        map.addAttribute("result",new java.util.Date());
        return map;
    }
}

 在浏览器输入http://localhost:8080/swagger-ui.html,可查看是否整合成功

至此我们的额api在线文档整合完成了,下面是效果图

以上就是Spring boot整合Springfox生成restful的在线api文档的详细内容,更多关于Spring boot整合Springfox生成restful在线api的资料请关注脚本之家其它相关文章!

相关文章

  • java持久层框架mybatis防止sql注入的方法

    java持久层框架mybatis防止sql注入的方法

    下面小编就为大家带来一篇java持久层框架mybatis防止sql注入的方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-10-10
  • 浅谈java中字节与字符的区别

    浅谈java中字节与字符的区别

    这篇文章主要介绍了浅谈java中字节与字符的区别,字节是java中的基本数据类型,用来申明字节型的变量;字符是语义上的单位,它是有编码的,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • JAVA  静态的单例的实例详解

    JAVA 静态的单例的实例详解

    这篇文章主要介绍了JAVA 静态的单例的实例详解的相关资料,这里提供了实例方法,来说名不仅实现了延迟加载,又可以保证线程安全,不影响系统性能,需要的朋友可以参考下
    2017-07-07
  • SpringBoot无法解析parameter参数问题的解决方法

    SpringBoot无法解析parameter参数问题的解决方法

    使用最新版的 Springboot 3.2.1(我使用3.2.0)搭建开发环境进行开发,调用接口时出现奇怪的错,本文小编给大家介绍了SpringBoot无法解析parameter参数问题的原因及解决方法,需要的朋友可以参考下
    2024-04-04
  • 简单谈谈RxJava和多线程并发

    简单谈谈RxJava和多线程并发

    认识RxJava已经有一段时间了,但是一直没有机会在项目中尝试,最近在新的项目里引进了RxJava写一些事件处理,在review代码的时候发现了一些和多线程并发相关的问题,所以写了这篇文章,需要的朋友可以参考借鉴,下面来一起看看吧。
    2017-03-03
  • Spring中的EurekaServer启动详解

    Spring中的EurekaServer启动详解

    这篇文章主要介绍了Spring中的EurekaServer启动详解,初始化eureka,包含eureka集群的同步和发布注册,这个方法时重写ServletContextListener#contextInitialized,是eureka启动的入口了,需要的朋友可以参考下
    2023-11-11
  • JVM的内存回收及常见算法小结

    JVM的内存回收及常见算法小结

    这篇文章主要介绍了JVM的内存回收及常见算法,需要的朋友可以参考下
    2023-05-05
  • SpringBoot实现国际化i18n详解

    SpringBoot实现国际化i18n详解

    国际化(Internationalization,简称i18n)是指在软件应用中支持多种语言和文化的能力,本文将介绍如何在Spring Boot应用中实现国际化,需要的可以参考下
    2024-12-12
  • SpringBoot@DeleteMapping(/xxx/{id})请求报405的解决

    SpringBoot@DeleteMapping(/xxx/{id})请求报405的解决

    这篇文章主要介绍了SpringBoot@DeleteMapping(/xxx/{id})请求报405的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-01-01
  • JAVA十大排序算法之归并排序详解

    JAVA十大排序算法之归并排序详解

    这篇文章主要介绍了java中的归并排序,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-08-08

最新评论