从零搭建springcloud项目- swagger（8）

最新推荐文章于 2024-05-02 22:24:32 发布

qq_29673919

最新推荐文章于 2024-05-02 22:24:32 发布

阅读量741

点赞数

分类专栏：微服务 swagger knife4j 文章标签： spring cloud spring boot swagger2

本文链接：https://blog.csdn.net/qq_29673919/article/details/122861977

版权

微服务同时被 3 个专栏收录

9 篇文章 4 订阅

订阅专栏

swagger

1 篇文章 0 订阅

订阅专栏

knife4j

1 篇文章 0 订阅

订阅专栏

1、配置swagger接口文档，引入依赖，可能下载失败，可以找一个版本下载

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

https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-boot-starter

2、配置yml

knife4j:
  enable: true #是否开启Knife4j增强模式
  documents: #自定义文档集合，该属性是数组
    - group: 2.X版本 #所属分组
      name: 接口签名 #类似于接口中的tag,对于自定义文档的分组
      locations: classpath:sign/* #markdown文件路径,可以是一个文件夹(classpath:markdowns/*)，也可以是单个文件(classpath:md/sign.md)
  setting: #前端Ui的个性化配置属性
    language: zh-CN #Ui默认显示语言,目前主要有两种:中文(zh-CN)、英文(en-US)
    enableSwaggerModels: true #是否显示界面中SwaggerModel功能
    enableDocumentManage: true #是否显示界面中"文档管理"功能
    swaggerModelName: 实体类列表 #重命名SwaggerModel名称,默认
    enableVersion: false #是否开启界面中对某接口的版本控制,如果开启，后端变化后Ui界面会存在小蓝点
    enableReloadCacheParameter: false #是否在每个Debug调试栏后显示刷新变量按钮,默认不显示
    enableAfterScript: true #调试Tab是否显示AfterScript功能,默认开启
    enableFilterMultipartApiMethodType: POST #具体接口的过滤类型
    enableFilterMultipartApis: false #针对RequestMapping的接口请求类型,在不指定参数类型的情况下,如果不过滤,默认会显示7个类型的接口地址参数,如果开启此配置,默认展示一个Post类型的接口地址
    enableRequestCache: true #是否开启请求参数缓存
    enableHost: false #是否启用Host
    enableHostText: 192.168.110.150:80
    enableHomeCustom: false #是否开启自定义主页内容
    homeCustomLocation: classpath:markdown/home.md #主页内容Markdown文件路径
    enableSearch: false #是否禁用Ui界面中的搜索框
    enableFooter: false #是否显示Footer
    enableFooterCustom: true #是否开启自定义Footer
    footerCustomContent: Copyright  2020 萃言教育科技有限责任公司 #自定义Footer内容
    enableDynamicParameter: false #是否开启动态参数调试功能
    enableDebug: true #启用调试
    enableOpenApi: false #显示OpenAPI规范
    enableGroup: true #显示服务分组
  cors: false #是否开启一个默认的跨域配置,该功能配合自定义Host使用
  production: false #是否开启生产环境保护策略,详情参考文档
  basic: #对Knife4j提供的资源提供BasicHttp校验,保护文档
    enable: false #关闭BasicHttp功能
    username: test #basic用户名
    password: 12313 #basic密码

3、代码配置扫描路径

package com.example.test002.config.swagger;

import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

/**
 * swagger配置
 * @author admin
 * @date 2022/2/10 14:03
 **/
@Configuration
@EnableSwagger2WebMvc
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfiguration {

    // 引入Knife4j提供的扩展类
    private final OpenApiExtensionResolver openApiExtensionResolver;

    @Autowired
    public SwaggerConfiguration(OpenApiExtensionResolver openApiExtensionResolver) {
        this.openApiExtensionResolver = openApiExtensionResolver;
    }


    @Bean(value = "defaultApi")
    public Docket defaultApi() {

        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("测试接口文档")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.test002.controller"))  //扫描路径
                .paths(PathSelectors.any())
                .build()
                //赋予插件体系
                .extensions(openApiExtensionResolver.buildExtensions("3.默认接口"));
        return docket;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger接口API")
                .description("# swagger-bootstrap-ui-demo RESTful APIs")
                .termsOfServiceUrl("http://www.xx.com/")
                .version("1.5")
                .build();
    }



}

4、controller 配置注解

//类注解
@Api(tags = "es测试类")
@ApiSort(value = 1)

// 方法注解
 @ApiOperationSupport(order = 1)
    @ApiOperation(value = "查询学校", notes = "ai检测，搜索学校")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "source", value = "索引配置", paramType = "query", required = true),
            @ApiImplicitParam(name = "index", value = "索引名称", paramType = "query", required = true)
    })

完整的方法

package com.example.test002.controller;


import com.alibaba.fastjson.JSONObject;
import com.example.test002.entity.ElasticEntity;
import com.example.test002.entity.SysUserDO;
import com.example.test002.mapper.common.ElasticSearchMapper;
import com.github.xiaoymin.knife4j.annotations.ApiOperationSupport;
import com.github.xiaoymin.knife4j.annotations.ApiSort;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.elasticsearch.common.unit.TimeValue;
import org.elasticsearch.index.query.BoolQueryBuilder;
import org.elasticsearch.index.query.QueryBuilder;
import org.elasticsearch.index.query.QueryBuilders;
import org.elasticsearch.search.builder.SearchSourceBuilder;
import org.elasticsearch.search.sort.ScoreSortBuilder;
import org.elasticsearch.search.sort.SortOrder;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import java.util.List;
import java.util.concurrent.TimeUnit;


/**
 * es 测试
 * @author admin
 * @date 2022/2/10 9:47
 */
@RestController
@RefreshScope               //nacos配置中心动态刷新
@Api(tags = "es测试类")
@ApiSort(value = 1)
public class ElasticsearchController {

    @Resource
    private ElasticSearchMapper elasticSearchMapper;

    /**
     * 功能描述: 创建索引
     * @author admin
     * @return boolean
     * @date 2022/2/10 13:30
     */
    @GetMapping(value = "/es/createIndex")
    @ApiOperationSupport(order = 1)
    @ApiOperation(value = "查询学校", notes = "ai检测，搜索学校")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "source", value = "索引配置", paramType = "query", required = true),
            @ApiImplicitParam(name = "index", value = "索引名称", paramType = "query", required = true)
    })
    public boolean createIndex() throws InterruptedException {
        // 大致意思就是配置了四个字段，id、username、tel、rolename
        // username和rolename 指定使用ik分词器，后面搜索的时候可以分词搜索
        String source =  "{" +
                "            \"properties\": {" +
                "                \"id\": {" +
                "                    \"type\": \"long\"" +
                "                }," +
                "                \"username\": {" +
                "                    \"type\": \"text\"," +
                "                    \"analyzer\": \"ik_max_word\"," +
                "                    \"search_analyzer\": \"ik_max_word\"" +
                "                }," +
                "                \"tel\": {" +
                "                    \"type\": \"keyword\"" +
                "                }," +
                "                \"rolename\": {" +
                "                    \"type\": \"text\"," +
                "                    \"analyzer\": \"ik_max_word\"," +
                "                    \"search_analyzer\": \"ik_max_word\"" +
                "                }" +
                "            }" +
                "        }";


        JSONObject json = JSONObject.parseObject(source);
        String s = JSONObject.toJSONString(json);

        boolean index = elasticSearchMapper.createIndex("test_user", s);
        return index;
    }

    /**
     * 功能描述: 判断是否存在这个索引
     * @author admin
     * @return boolean
     * @date 2022/2/10 14:22
     */
    @GetMapping(value = "/es/indexExist")
    public boolean indexExist() throws InterruptedException {

        boolean index = elasticSearchMapper.indexExist("test_user");
        return index;
    }

    /**
     * 功能描述: 插入单条
     * @author admin
     * @return boolean
     * @date 2022/2/10 14:22
     */
    @GetMapping(value = "/es/insertOne")
    public boolean insertOne() throws InterruptedException {
        SysUserDO user = new SysUserDO();
        user.setId(1);
        user.setRolename("测试一下");
        user.setUsername("我是测试");
        user.setTel("1311111111");

        ElasticEntity entity = new ElasticEntity();
        entity.setData(user);

        boolean index = elasticSearchMapper.insertOne("test_user", entity);
        return index;
    }

    /**
     * 功能描述: 判断是否存在这个索引
     * @author admin
     * @return boolean
     * @date 2022/2/10 14:22
     */
    @GetMapping(value = "/es/listByBuilder")
    public List<SysUserDO> listByBuilder() throws InterruptedException {
        // 使用分词，查询username和rolename中含有测试的
        QueryBuilder nameQuery = QueryBuilders.matchQuery("username", "测试").analyzer("ik_max_word");
        QueryBuilder roleQuery = QueryBuilders.matchQuery("rolename", "测试").analyzer("ik_max_word");

        /*
         * 组合查询
         */
        BoolQueryBuilder boolQueryBuilder = QueryBuilders.boolQuery();
        boolQueryBuilder.should(nameQuery);
        boolQueryBuilder.should(roleQuery);

        /* 封装查询builder SearchSourceBuilder
         * 开启评分
         * 设置超时时间
         * 分数排序
         * 查询条件
         */
        SearchSourceBuilder sourceBuilder = new SearchSourceBuilder();
        sourceBuilder.explain(true);
        sourceBuilder.timeout(new TimeValue(60, TimeUnit.SECONDS));
        sourceBuilder.sort(new ScoreSortBuilder().order(SortOrder.DESC));
        sourceBuilder.query(boolQueryBuilder);

        String[] indexArray = new String[]{"test_user"};
        List<SysUserDO> userList = elasticSearchMapper.listByBuilder(indexArray, sourceBuilder, SysUserDO.class);

        return userList;
    }

}

5、访问路径