005.SpringBoot-RESTful-API-接口文档组件Swagger2

最新推荐文章于 2024-11-14 21:50:35 发布

Teln_小凯

最新推荐文章于 2024-11-14 21:50:35 发布

阅读量541

点赞数

分类专栏： SpringBoot 文章标签： spring boot restful postman

本文链接：https://blog.csdn.net/qq873113580/article/details/122385996

版权

SpringBoot 专栏收录该内容

96 篇文章 1 订阅

订阅专栏

本文档介绍了如何在SpringBoot项目中集成Swagger2和Swagger-UI，通过添加相关依赖并配置启动类和Swagger配置文件，实现API的自动化文档生成。读者将学习到如何配置 SwaggerUI 以访问接口文档，并理解如何通过@Api 和 @ApiOperation 注解来描述接口及操作。

摘要由CSDN通过智能技术生成

添加依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

启动类添加注解@EnableWebMvc 即可

package com.java.core;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;

@EnableWebMvc
@SpringBootApplication
public class CoreApplication {
    //项目启动时执行的方法
    public static void main(String[] args) {
        //SpringApplication.run(CoreApplication.class, args);
        // 获取 Spring Boot 上下文
        ConfigurableApplicationContext ctx = SpringApplication.run(CoreApplication.class, args);
        //获取配置的端口
        //System.out.println(ctx.getEnvironment().getProperty("server.port"));
        //加密数据自动解密
        System.out.println(ctx.getEnvironment().getProperty("admin.password"));

        //配置类的读取
        //Config cg = (Config) ctx.getBean("config");
        //ctx.close();
    }

}

新建Swagger配置文件，需要和启动类在一个级别


@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.java.core"))
                .paths(PathSelectors.any())
                .build().apiInfo(new ApiInfoBuilder()
                        .title("SpringBoot整合Swagger")
                        .description("SpringBoot整合Swagger，详细信息......")
                        .version("9.0")
                        .contact(new Contact("啊啊啊啊","blog.csdn.net","aaa@gmail.com"))
                        .license("The Apache License")
                        .licenseUrl("http://www.baidu.com")
                        .build());
    }
}

新建SwaggerUI自动发布类，建议和上面的类也是在同一级

package com.java.core;

import org.springframework.context.annotation.Configuration;
import org.springframework.util.ResourceUtils;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

@Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {

    /**
     * 访问静态资源
     * */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        /**
         * SpringBoot自动配置本身并不会把/swagger-ui.html
         * 这个路径映射到对应的目录META-INF/resources/下面
         * 采用WebMvcConfigurerAdapter将swagger的静态文件进行发布;
         */
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
        //将所有/static/** 访问都映射到classpath:/static/ 目录下
        registry.addResourceHandler("/static/**").addResourceLocations(ResourceUtils.CLASSPATH_URL_PREFIX +"/static/");
        super.addResourceHandlers(registry);
    }
}

访问接口文档

http://localhost:8080/swagger-ui.html

这里可以直接调试接口

配置介绍

接口配置

@Api(tags = "用户管理")
@ApiImplicitParam(paramType = "path", dataType = "Long", name = "id", value = "用户编号", required = true, example = "1")
@ApiOperation(value = "更新用户详细信息", notes = "根据url的id来指定更新对象，并根据传过来的user信息来更新用户详细信息")