1.在原有的springboot-mybatis上配置
2.導入swagger包
<!-- swagger2包 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.4.0</version>
</dependency>
3.使用註解配置swagger。
@ApiOperation(value = "獲取用戶列表")
@ApiOperation(value = "用戶登錄", notes = "這是登錄測試")
。。。。。
package com.mwk.myproject.controller;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import com.mwk.myproject.entity.User;
import com.mwk.myproject.service.UserService;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
/**
* springboot-mybatis配置練習
*
* @author 凱凱
*
*/
@RestController
public class UserController {
@Autowired
private UserService userService;
@ApiOperation(value = "獲取用戶列表")
@RequestMapping(value = "findAll", method = RequestMethod.GET)
public Map<String, Object> findAll() {
Map<String, Object> map = new HashMap<>();
List<User> ulist = userService.findAll();
map.put("result", ulist);
map.put("status", 200);
map.put("message", "請求成功");
return map;
}
@ApiOperation(value = "用戶登錄", notes = "這是登錄測試")
@RequestMapping(value = "login", method = RequestMethod.POST)
public Map<String, Object> login(@ApiParam(value = "賬號") @RequestParam("name") String name,
@ApiParam(value = "年齡,這裏假設爲密碼") @RequestParam("age") Integer age) {
Map<String, Object> map = new HashMap<>();
if (name == null || age == null) {
map.put("status", 203);
map.put("message", "賬號或密碼爲空");
return map;
}
User u = userService.findUserByName(name);
if (u != null) {
if (u.getAge() == age) {
map.put("status", 200);
map.put("message", "登錄成功");
} else {
map.put("status", 201);
map.put("message", "密碼錯誤");
}
} else {
map.put("status", 202);
map.put("message", "賬號錯誤");
}
return map;
}
}
4.配置swagger.java
package com.mwk.myproject;
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;
@Configuration
@EnableSwagger2
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.mwk.myproject"))
.paths(PathSelectors.any())
.build();
}
@SuppressWarnings("deprecation")
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("SpringBoot-Mybatis-Swagger練習")
.contact("閔渭凱")
.version("1.0")
.build();
}
}
5.打開瀏覽器運行
http://localhost/swagger-ui.html#/
出現這樣就成功了