swagger使用

最新推荐文章于 2023-10-08 21:22:12 发布

我叫果冻

最新推荐文章于 2023-10-08 21:22:12 发布

阅读量81

点赞数

分类专栏： Java 文章标签： java 开发语言

本文链接：https://blog.csdn.net/GZ946/article/details/125180806

版权

Java 专栏收录该内容

23 篇文章 1 订阅

订阅专栏

swagger使用

1.配置pom文件

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

2.新建配置

@Configuration
@EnableSwagger2
public class SwaggerAutoConfiguration {
	@Bean
	public Docket createRestApi1() {
		Docket docket = new Docket(DocumentationType.SWAGGER_2)
				.apiInfo(apiInfo())
				.select()
				//为当前包路径
				.apis(RequestHandlerSelectors.basePackage("cn.gz.controller"))
				.build();
		return docket;
	}

	//构建 api文档的详细信息
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				//页面标题
				.title("API接口文档")
				//创建人
				.contact(new Contact("演示", "http://www.baidu.com", ""))
				//版本号
				.version("1.0")
				//描述
				.description("API 描述")
				.build();
	}
}

3.配置controller

@RestController
@RequestMapping("/menu")
@Api(tags = "菜单控制器")
public class MenuController {
	@GetMapping("/getMenus")
	@ApiOperation(value = "查询所有菜单", notes = "查询所有菜单信息")
	public List<Menu> getMenus(){
		Menu menu = new Menu();
		menu.setId(100);
		menu.setName("itcast");
		List<Menu> list = new ArrayList<>();
		list.add(menu);
		return list;
	}

	@PostMapping("/save")
	@ApiOperation(value = "新增菜单", notes = "新增菜单信息")
	public String save(@RequestBody Menu menu){
		return "OK";
	}

	@ApiImplicitParams({
			@ApiImplicitParam(name = "pageNum", value = "页码",
					required = true, type = "Integer"),
			@ApiImplicitParam(name = "pageSize", value = "每页条数",
					required = true, type = "Integer"),
	})
	@ApiOperation(value = "分页查询菜单信息")
	@GetMapping(value = "page/{pageNum}/{pageSize}")
	public String findByPage(@PathVariable Integer pageNum,
	                         @PathVariable Integer pageSize) {
		return "OK";
	}
}