7-5-Swagger

最新推荐文章于 2024-09-05 16:35:33 发布

原创最新推荐文章于 2024-09-05 16:35:33 发布 · 177 阅读

0 ·

CC 4.0 BY-SA版权

new项目专栏收录该内容

47 篇文章

订阅专栏

本文档介绍了如何使用Swagger2为Spring Boot应用生成RESTful API文档，并展示了Swagger UI的主要功能，包括接口分组、在线测试等。通过在方法、参数和实体类上添加注解，可以为API提供详细的描述，实现文档的实时更新。Swagger2不仅提供了接口文档，还允许开发者直接在文档中进行接口的黑盒测试，提高了开发效率。

导入依赖X2：

<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>

启动类加上注解：

@EnableSwagger2

@SpringBootApplication
@EnableSwagger2
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

然后直接启动即可访问swagger主页

swagger主页：

端口/swagger-ui.html#/

标题主页分为四个部分：

1.右上角是组号，在IDEA SwaggerConfig配置类中配置组，然后可以查看不同组编写的接口。
2.有了组就可以执行分组编写接口文档，从而产生第二个部分，Swagger作者的信息
3.第三个部分就是接口
4.第四个部分是实体类

配置组

1.第一种直接配置好名字
在这里插入图片描述

2.第二种，除了配置名称，还可以配置要操作的Controller，以及何种环境（生产环境【不开启，提高效率】 or 开发环境）
在这里插入图片描述

使用注解编写接口文档（在比较难读懂的情况下）

@ApiOperation("新增方法")
public String input(@ApiParam("名称")String name){
	return "";
}

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

	@ApiModelProperty("用户名")
	private String name;
}