首页 > 其他分享 >Swagger整合

Swagger整合

时间:2023-08-21 10:35:12浏览次数:32  
标签:springfox Swagger 接口 文档 整合 new swagger com

1. Swagger作用:生成接口说明文档;对接口进行测试。

2. 整合

2.1 在api子工程添加依赖(Swagger2 \ Swagger UI)

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

2.2 在 api子工程 创建swagger的配置(Java配置方式)

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    /*swagger会帮助我们生成接口文档
     * * 1:配置生成的文档信息
     * 2: 配置生成规则*/

    /*Docket封装接口文档信息*/
    @Bean
    public Docket getDocket() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2); //指定文档风格
        //如何获取一个接口对象
        //new接口,需要在构造器后的{}实现接口中所有抽象方法
        //new 子类/实现类
        //工厂模式

        //创建封面信息对象
        ApiInfoBuilder apiInfoBuilder = new ApiInfoBuilder();
        apiInfoBuilder.title("《锋迷商城》后端接口说明") //标题
                .description("此文档详细说明了锋迷商城项目后端接口规范")
                .version("2.0.1") //版本
                .contact(new Contact("林林","www.baidu.com","[email protected]"));
        ApiInfo apiInfo = apiInfoBuilder.build();

        docket.apiInfo(apiInfo) //指定生成的文档中的封面信息:文档标题,版本,作者
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.linlin.fmmall.controller"))
                .paths(PathSelectors.any())
                .build();

        return docket;
    }

}

2.3 测试

启动springboot应用,浏览器访问:http://localhost:8081/swagger-ui.html

 2.4 knife4j插件

在pom文件中替换swagger的两个依赖

        <!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-boot-starter -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>3.0.3</version>
        </dependency>

启动springboot应用,浏览器访问:http://localhost:8081/doc.html

标签:springfox,Swagger,接口,文档,整合,new,swagger,com
From: https://www.cnblogs.com/linlin227/p/17625952.html

相关文章

  • SSM框架整合Maven版
    简单介绍一下SSM具体指的是SpringMvc、Spring、Mybatis或者MybatisPlus这三大框架,其中Spring是最核心的框架,其他两个框架都要集成在Spring上让其进行统一管理。由于整合过程中需要导入很多jar包所以为了方便管理使用项目管理工具Maven来进行依赖jar包的管理,需要什么jar包就导入什么......
  • SpringBoot整合(部分内容)
    1.springboot整合数据源--连接数据库1.1pom文件配置首先,创建SpringBoot项目时勾选创建好之后在pom文件中继续添加Druid数据库连接池依赖<!--数据库连接池--><dependency><groupId>com.alibaba</groupId><artifactId>druid-spri......
  • 文字转语音 - 搭建微软tts整合web服务提供api接口(免费)
     微软tts是业界公认文字转语音效果最佳本文使用docker搭建微软tts服务并提供api接口对外提供服务对接官方免费在线体验接口,搭建后可免费进行调用使用,不保证永久稳定可用调用方式url:http://127.0.0.1:5003/ttsmethod:POST参数 类型 描述text string 语音文字内容voiceName stri......
  • Springboot整合模版方法模式概念->原理优缺点->框架应用场景->企业级实战
    一、前言常见的设计模式有23种,我们不得不提到模板方法设计模式,这是一种在软件开发中广泛使用的行为型设计模式之一。它为我们提供了一种优雅的方式来定义算法的结构,并将算法的具体实现延迟到子类中!在本篇博客中,我们将深入探讨模板方法设计模式在SpringBoot中的应用。我们将从概念......
  • 从0开始,Cloudreve开源云盘在centos7上部署,并可在外网访问(资料整合)
    全程我在网络上收集这些资料,太零碎了,每一个一看就会,一动手就废,而且很多都不能实现我白嫖的梦想我一个人折腾了快一周,现在可以正常访问手机电脑多端访问给个赞再走吧此处为没有公网IP(回去折腾你家宽带去,不知道可以去搜索如何获得)和域名的办法简单的说就是想完全白嫖的那种(甚至......
  • 详谈 springboot整合shiro
    背景:上文学习了shrio基本概念后,本章将进一步的落地实践学习,在springboot中如何去整合shrio,整个过程步骤有个清晰的了解。 利用Shiro进行登录认证主要步骤:1.添加依赖:首先,在pom.xml文件中添加SpringBoot和Shiro的相关依赖。<!--SpringBoot--><dependency><groupI......
  • flask swagger ui文档生成
    最近一直在写api文档,不知道兄弟们有没有和我一样的感受,写文档比写代码还难受,写代码逻辑实现提交就完事了,写api文档那才叫难受,有些不合理的地方给反复来回改好几遍,不止代码要改,文档要改,注释要改,关键是文档还要让别人能看得懂为了解决这个痛点我想起了swaggerui文档,因为我......
  • Spring 与 Spring MVC 相关知识点回顾整合
    1.Spring框架1.1.Spring框架的作用Spring框架主要解决了创建对象和管理对象的相关问题。通过Spring创建并管理对象,可以使得开发者不再反复关心对象的创建过程,并且,默认情况下,由Spring创建的对象都是单例的,这是非常有必要的!由Spring创建的对象通常称之为SpringBean。由于Sp......
  • springboot 整合sentinel 和nacos实现流量控制
    方案一使用sentinel控制面板1、启动sentineljava-jarsentinel.jar2、在自己应用user中添加依赖<modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-pa......
  • SpringBoot3 学习笔记 (整合Druid)
    一、Druid Github地址:https://github.com/alibaba/druid/二、配置数据源1、在https://mvnrepository.com/artifact/com.alibaba/druid上找最新的版本 2、在pom.xml中添加上Druid数据源依赖<!--https://mvnrepository.com/artifact/com.alibaba/druid--><dependency......