先后端分离的项目,接口文档的存在十分重要。与手动编写接口文档不一样,swagger是一个自动生成接口文档的工具,在需求不断变动的环境下,手动编写文档的效率实在过低。与新版的swagger3相比swagger2配置更少,使用更加方便。php
1、pom文件中引入Swagger3依赖<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency>
2、Application上面加入@EnableOpenApi注解html
@EnableOpenApi @SpringBootApplication @MapperScan(basePackages = {"cn.ruiyeclub.dao"}) public class Swagger3Application { public static void main(String[] args) { SpringApplication.run(Swagger3Application.class, args); } }
3、Swagger3Config的配置spring
@Configuration public class Swagger3Config { @Bean public Docket createRestApi() { return new Docket(DocumentationType.OAS_30) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Swagger3接口文档") .description("更多请咨询服务开发者Ray。") .contact(new Contact("Ray。", "http://www.ruiyeclub.cn", "ruiyeclub@foxmail.com")) .version("1.0") .build(); } }4、Swagger注解的使用说明
@Api:用在请求的类上,表示对类的说明 tags="说明该类的做用,能够在UI界面上看到的注解" value="该参数没什么意义,在UI界面上也看到,因此不须要配置" @ApiOperation:用在请求的方法上,说明方法的用途、做用 value="说明方法的用途、做用" notes="方法的备注说明" @ApiImplicitParams:用在请求的方法上,表示一组参数说明 @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面 name:参数名 value:参数的汉字说明、解释 required:参数是否必须传 paramType:参数放在哪一个地方 · header --> 请求参数的获取:@RequestHeader · query --> 请求参数的获取:@RequestParam · path(用于restful接口)--> 请求参数的获取:@PathVariable · body(不经常使用) · form(不经常使用) dataType:参数类型,默认String,其它值dataType="Integer" defaultValue:参数的默认值 @ApiResponses:用在请求的方法上,表示一组响应 @ApiResponse:用在@ApiResponses中,通常用于表达一个错误的响应信息 code:数字,例如400 message:信息,例如"请求参数没填好" response:抛出异常的类 @ApiModel:用于响应类上,表示一个返回响应数据的信息 (这种通常用在post建立的时候,使用@RequestBody这样的场景, 请求参数没法使用@ApiImplicitParam注解进行描述的时候) @ApiModelProperty:用在属性上,描述响应类的属性
Controller层的配置:后端
View Codeapi
5、Swagger界面效果springboot
Swagger的访问路径由port/swagger-ui.html改为了port/swagger-ui/ 或port/swagger-ui/index.html,项目演示代码在springboot-swaggerrestful