项目配置swagger

我就是我 2024-03-24 13:58 42阅读 0赞

##### 一、maven引入依赖 #####

<dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
            </dependency>
            <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>swagger-bootstrap-ui</artifactId>
            </dependency>

##### 二、编写配置类 #####

@Configuration
    @EnableSwagger2
    @ConditionalOnExpression("${swagger.enable:true}")
    public class SwaggerConfig {
        
    
        @Bean
        public Docket createRestApi() {
        
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .directModelSubstitute(Long.class, String.class)
                    .directModelSubstitute(Integer.class,String.class)
                    .directModelSubstitute(BigDecimal.class,String.class)
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.xx.xxx.xxx.controller"))
                    //.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
    
                    .paths(PathSelectors.any())
                    .build();
        }
    
        private ApiInfo apiInfo() {
        
            return new ApiInfoBuilder()
                    .title("xx系统")
                    .description("xx系统 RESTful APIs")
    //                .termsOfServiceUrl("http://localhost:8090/")
                    .version("1.0")
                    .build();
        }
    }

##### 三、启动服务 #####

服务端口是port，查看swagger文档访问 `http://ip:port/doc.html`即可  
如果想导出文档可借助`http://xiaoyaoji.cn/`  
导出文档参考文章：https://blog.csdn.net/zhangHP\_123/article/details/121703158

发表评论取消回复

表情：

评论列表（有 0 条评论，42人围观）

还没有评论，来说两句吧...

相关阅读

相关项目配置swagger

一、maven引入依赖 <dependency> <groupId>io.springfox</groupId>

我就是我/ 2024年03月24日 13:58/ 0 赞/ 43 阅读

相关 [Swagger 接口工具] Swagger配置访问

Swagger 配置类包路径 ![在这里插入图片描述][20210427144524778.png] //这里是添加对应项目包路径 .apis(Reques

ゝ一纸荒年。/ 2023年10月04日 11:57/ 0 赞/ 46 阅读

相关 Springboot项目--swagger配置

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ub

川长思鸟来/ 2023年07月10日 12:47/ 0 赞/ 26 阅读

相关 Swagger配置WebApi

目录前言通用必备操作添加Swashbuckle.AspNetCore引用（.net 5项目创建完整版项目时会自动引用）创建版

﹏ヽ暗。殇╰゛Y/ 2023年01月15日 08:11/ 0 赞/ 177 阅读

相关项目配置Swagger2生成API接口文档

一、Swagger2介绍前后端分离开发模式中，api文档是最好的沟通方式。 Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格

逃离我推掉我的手/ 2022年11月20日 09:38/ 0 赞/ 296 阅读

相关项目配置swagger(亲测能用)

项目配置swagger---(亲测能用) 一,前言 Swagger的好处这里就不在敷衍了, 高效简洁界面优美节省时间等等读者可以自己去

今天药忘吃喽~/ 2022年05月23日 05:24/ 0 赞/ 215 阅读

相关 Swagger(一）项目中的swagger配置

目录一.引入依赖；二.配置swagger 三.界面展示四：使用swagger注解五.例子六.注意：七：后期需要，再贴出其他相关配置一.引入依赖；

╰半夏微凉°/ 2022年04月15日 02:37/ 0 赞/ 349 阅读

相关 SpringBoot配置Swagger

[Swaager][] 是一个开源用于设计、撰写、测试 RESTful API 的工具,今天学习如何SpringBoot配置Swagger 一、pom.xml中加入jar依赖

男娘i/ 2022年03月26日 09:10/ 0 赞/ 301 阅读

相关项目整合Swagger

> 整个项目还是比较大的，测试起来很麻烦，通过swagger来进行集中测试就会方便很多，浏览器中deletemapping等不能测试，可使用swagger进行测试 > > 下

╰+哭是因爲堅強的太久メ/ 2021年09月25日 06:50/ 0 赞/ 421 阅读

相关（一） spring boot 项目初始化 + 配置swagger页面

1 SpringBoot是什么 -------------------- Spring Boot 是由 Pivotal 团队提供的全新框架，其设计目的是用来简化新 Sp

偏执的太偏执、/ 2021年08月19日 12:39/ 0 赞/ 488 阅读