最近要做前后端彻底分离,正在拆分项目,我负责把API提供出来给前端
首先添加pom依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
1、将swagger-ui中的界面配置至spring-boot环境
spring-boot有自己的一套web端拦截机制,若需要看到swagger发布的api文档界面,需要做一些特殊的配置,将springfox-swagger-ui包中的ui界面暴露给spring-boot资源环境。
swagger配置
import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket swaggerSpringMvcPlugin() {
return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();
}
}
2、API文档编写示例
可以尽可能在controller中指定前端ajax访问的方式,否则生成的API会生成全部的方式的接口,显得非常恶心
@Api(description = "用户接口")
@RequestMapping("/user")
@RestController
public class SysUserController extends BaseController {
@Autowired
private SysUserService sysUserService;
@Autowired
private SysUserRoleService sysUserRoleService;
/**
* 用户列表
*
* @param page
* @return
*/
@ApiOperation(value = "用户列表", notes = "分页查询用户信息")
@RequestMapping(value = "list",method = RequestMethod.GET)
@RequiresPermissions("sys:user:list")
public PageData list(Page page) {
return sysUserService.getUserList(page);
}
效果图如下