Commit 34c3c531 authored by wujipeng's avatar wujipeng
Browse files

swagger配置

parent ba0eb8a2
package com.ruzhoukj.sms.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* Created with IntelliJ IDEA.
* User: QianMo
* Date: 2020/8/26
* Time: 11:20
* swagger配置类
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket docket(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo()) //这个方法的作用(生成接口的时候页面显示的信息)
.select() //表示的是选择那些路径和API生成文档
.apis(RequestHandlerSelectors.basePackage("com.ruzhoukj.sms.controller")) //告诉他要扫描的接口存在的这个包
.paths(PathSelectors.any()) //对所有的API进行监控
.build(); //构建
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("平台API") //文档的标题
.description("平台API") //文档的描述
.version("v1.0") //版本
.build();
// .contact("QianMo") //作者
}
}
...@@ -3,6 +3,7 @@ package com.ruzhoukj.sms.controller; ...@@ -3,6 +3,7 @@ package com.ruzhoukj.sms.controller;
import com.ruzhoukj.sms.common.Result; import com.ruzhoukj.sms.common.Result;
import com.ruzhoukj.sms.entity.UserEntity; import com.ruzhoukj.sms.entity.UserEntity;
import com.ruzhoukj.sms.service.UserService; import com.ruzhoukj.sms.service.UserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
...@@ -11,6 +12,7 @@ import java.util.List; ...@@ -11,6 +12,7 @@ import java.util.List;
@RestController @RestController
@RequestMapping("/user") @RequestMapping("/user")
@Api(tags = "用户管理")
public class UserController { public class UserController {
@Resource @Resource
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment