首页 > 其他分享 >swagger的使用及配置

swagger的使用及配置

时间:2022-09-07 18:24:40浏览次数:55  
标签:swagger 配置 documentation PathSelectors 使用 import springfox com

引入坐标

 <!--swagger-->
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>${swagger.version}</version>
            </dependency>
            <!--swagger ui-->
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>${swagger.version}</version>
            </dependency>

编写配置类

package com.itcast.servicebase;

import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration//配置类
@EnableSwagger2//swagger注解
public class SwaggerConfig {
    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();

    }

    private ApiInfo webApiInfo(){

        return new ApiInfoBuilder()
                .title("网站-课程中心API文档")
                .description("本文档描述了课程中心微服务接口定义")
                .version("1.0")
                .contact(new Contact("java", "http://itcst.com", "[email protected]"))
                .build();
    }

}

控制层上面写

@Api(description ="")

在方法上写

@ApiOperation(value = "")

在变量上写

@ApiParam(name = "current", value = "当前页", required = true) 

 

访问地址是:Swagger UI

标签:swagger,配置,documentation,PathSelectors,使用,import,springfox,com
From: https://www.cnblogs.com/Galaxy1/p/16666762.html

相关文章

  • 软件安装——tortoiseGit安装和配置
    Tortoisegit安装指南TortoiseGit是一个开放的Git版本控制系统的源客户端,它是Git和Windows资源管理器的整合,提供了Git的图形化操作界面一、软件安装1.进入tortoisegit官......
  • [安装配置] Linux docker 安装
    官方安装文档地址:https://docs.docker.com/engine/install/centos/1.卸载旧版本dockersudoyumremovedocker\docker-client\......
  • java读取和设置配置文件中的属性参数
    想必大家和我一样经常在项目中读取一些配置文件,因为读取的配置很少,结构简单又不想搞个读取xml,比较麻烦。所以这时大多采取读取.properties配置文件,我们和大名鼎鼎的log4j......
  • 如何配置Maven和JDK
    一、配置Maven环境(1)点击File下Settings(2)在输入框中输入maven,配置成功后先点击Apply在点击OK。 三、配置JDK(1)点击file下的NewProiectsSetup (2)直接弹出Project......
  • 解决Microsoft store界面显示无网络连接或者下载的应用无网络连接无法使用的问题
    发现——电脑可以上网,但Microsoftstore界面显示无网络连接或者下载的应用无网络连接无法使用。思考:正常上网没问题,但只要与微软账户有关的软件均无法使用。解决:禁用网络......
  • jmeter配置元件
    线程组-右键添加-配置元件  1:csv配置文件文件名:通过右侧的浏览按钮,尽量选择jmeter-bin路径的地址文件编码:UTF-8变量名称:name,password(英文逗号间隔)消息体......
  • 使用SLF4J和LOGBACK (二 :核心组件 )
    在正式使用和配置logback之前,先来了解一下logback中的三个核心组件,日后的使用,我们配置的也是这三类核心组件。所以有必要先对它们有个基础了解。1. 日志记录器(Logger)L......
  • TP6框架--CRMEB学习笔记:项目初始化+环境配置
    这里给大家分享我在网上总结出来的一些知识,希望对大家有所帮助最近在研究一个基于TP6的框架CRMEB,这里分享下我的开发心得首先要获取原始项目文件这里是git地址https:......
  • Golang中使用new和make
    一、何时使用make和new?二、make和new的区别1.new这个内置函数用来分配内存。第一个参数是类型,而不是值,返回值是指向该类型的新分配的零值(默认值)的指针。例如:此时......
  • mysql中find_in_set()函数的使用及in()用法详解
    这篇文章主要介绍了mysql中find_in_set()函数的使用以及in()用法详解,需要的朋友可以参考下 MySQL手册中find_in_set函数的语法解释:FIND_IN_SET(str,strlist)str要......