springboot集成swagger

发布时间:2024-09-04 16:01

Swagger依赖包

		
        <dependency>
            <groupId>io.springfoxgroupId>
            <artifactId>springfox-swagger2artifactId>
            <version>2.9.2version>
        dependency>
        <dependency>
            <groupId>io.springfoxgroupId>
            <artifactId>springfox-swagger-uiartifactId>
            <version>2.8.0version>
        dependency>
        <dependency>
            <groupId>com.github.xiaoymingroupId>
            <artifactId>swagger-bootstrap-uiartifactId>
            <version>1.9.6version>
        dependency>
package com.sh.content.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
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;

/**
 * @author shs-xxaqbzylh4
 */
@Configuration
@EnableSwagger2
@Profile(\"test\") // todo 这个是分环境来访问的,test代表只能在测试环境访问swagger
public class SwaggerConfig {

    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(\"com.baidu.content-back.controller\"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该API的基本信息(这些基本信息会展现在文档页面中)
     * 访问地址:http://127.0.0.1:7021/content-back/doc.html todo content-back 是我的项目路径
     *
     * @return
     */
    private ApiInfo apiInfo() {
        Contact contact = new Contact(\"name\", \"网址\", \"邮箱\");
        return new ApiInfoBuilder()
                .title(\"标题\")
                .description(\"描述\")
                .termsOfServiceUrl(\"http://127.0.0.1:7021/content-back/doc.html\")
                .contact(contact)
                .version(\"1.0\")
                .build();
    }
}

启动项目访问地址http://127.0.0.1:7021/content-back/doc.html

\"springboot集成swagger_第1张图片\"

分环境访问问题,test是我的测试环境,大家根据实际情况来,而且这种只是接口文档不会加载,其他css还是会加载的,如果有其他硬性要求建议换方案来实现接口文档仅在测试环境访问
\"springboot集成swagger_第2张图片\"

你可能感兴趣的

相关推荐

Docker 实战总结(非常全面)

Vite+TS带你搭建一个属于自己的Vue3组件库

EDM邮件营销分析报告——自动化营销趋势下的邮件营销有待升级

python vim模块有哪些函数接口

centos7 安装 RabbitMq

MySQL 基础一(B站黑马程序员MySQL教程笔记)

基于PING命令的主机探测

缓存

数据结构 实验2——表达式求值

【爬虫知识】年少不知splash好,错把selenium当成宝

C++ OpenCV生成蒙太奇图像的示例详解

Hive/MaxCompute SQL性能优化(一):什么是数据倾斜

在vue自定义组件中使用 v-model指令详情

前端实现分页效果

这几个人脸识别解决方案你用过没?

MPU6050参考代码

python 模拟Http请求

Springboot详解如何整合使用Thymeleaf

1900套计算机毕业设计源码整合大全,ASP(499套),C++(24套),Java(100套),JSP(300套),PHP(76套),VB(350套)Andorid168套,swing11套...

ECMAScript6 ES6 语法

ItVuer - 免责声明 - 关于我们 - 联系我们

本网站信息来源于互联网,如有侵权请联系:561261067@qq.com

桂ICP备16001015号