SpringBoot集成swagger2（Kotlin）

最新推荐文章于 2024-07-24 20:28:15 发布

仄言*

最新推荐文章于 2024-07-24 20:28:15 发布

阅读量2.1k

点赞数 1

文章标签： spring boot kotlin java swagger2

本文链接：https://blog.csdn.net/qq_41247866/article/details/122645763

版权

1.新建模块

①创建模块，选择Spring Initializr，并配置模块相关基础信息
在这里插入图片描述

在这里插入图片描述

2.引入Swagger2依赖

	//引入swagger依赖
    implementation("io.springfox:springfox-swagger2:2.9.2")
    implementation("io.springfox:springfox-swagger-ui:2.9.2")

在这里插入图片描述

3.Swagger配置文件

/**
 * Swagger配置文件
 */
@Configuration //加载此配置到springboot配置中
@EnableSwagger2 //开启Swagger2
class SwaggerConfig {

    //配置Swagger的Docket的Bean实例
    @Bean
    fun docket(): Docket {
        return Docket(DocumentationType.SWAGGER_2)
            //是否开启Swagger
            .enable(true)
            .apiInfo(apiInfo())
            .select()
            //RequestHandlerSelectors 配置要扫描的接口的方式
            //basePackage 指定要扫描的包
            .apis(RequestHandlerSelectors.basePackage("包名"))
            .build()
    }

    //配置Swagger信息 apiInfo
    fun apiInfo(): ApiInfo {

        //作者信息
        val contact = Contact("作者名称“", "博客url", "邮箱")

        return ApiInfo(
            "标题",
            "描述",
            "v1.0",
            "服务条款网址",
            contact,
            "Apache 2.0",
            "http://www.apache.org/licenses/LICENSE-2.0",
            ArrayList()
        );

    }

}

4.相关API

①：@ApiModel 作用于实体类上
②：@ApiModelProperty 作用于实体类属性上

@ApiModel("用户实体类")
data class User(

    @ApiModelProperty("用户名")
    var username: String ?= null,

    @ApiModelProperty("密码")
    var password: String ?= null

)

③：@Api 作用于Controller类上
④：@ApiOperation 作用于方法上

@Api(description = "测试服务")
@RestController
@RequestMapping("/test")
class TestController {

    @ApiOperation("保存用户信息")
    @PostMapping("/save")
    fun save(@RequestBody user: User): User{
        return user
    }

}