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张图片\"

你可能感兴趣的

相关推荐

TCP/IP网络编程(1)

Ubuntu20.04安装Opencv4.5

了解区块链,体验NFT铸造、使用加密货币交易

UE_使用Instanced Mesh Component 和 Spline 在蓝图和c++中区别

【笔记,非教程】Anaconda (多Python环境)和pytorch(with GPU)安装

【Ajax】如何通过axios发起Ajax请求

预测——马尔可夫链

我的第一个java web表白情书

Python可视化神器pyecharts绘制水球图

WIFI钓鱼热点

米家、华为、飞利浦和智汀等智能家居技术有哪些示例,都有哪些优缺点

简历书写注意事项

(多头)自注意力机制的PyTorch实现

Flutter入门 -页面技巧

Lite Actor:方舟Actor并发模型的轻量级优化

react-路由组件传递参数的三种方式

MATLAB图像基本变换实验报告,MATLAB图像增强与变换处理实验报告

Docker数据管理

系统性综述:特征点检测与匹配

基于JavaWeb的失物领取平台网站设计与实现

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

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

桂ICP备16001015号