註解@swagger2的作用

作用：

使用swagger2構建restful接口測試

優點：

可以生成文檔形式的api並提供給不同的團隊

便於自測，也便於領導查閱任務量

無需過多冗餘的word文檔

如何使用

第一步：配置swagger類

package com.lpy;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.Contact;
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;
 
/**
 * 通過java代碼配置
 * @author Richard
 *
 *@Configuration表示是配置文件
 *@EnableSwagger2開啓這個配置
 *
 */
@Configuration
@EnableSwagger2
public class Swagger2 {
	/**
	 * @Description:swagger2的配置文件，這裏可以配置swagger2的一些基本的內容，比如掃描的包等等，注：讓我們的swagger2掃描我們controller
	 */
	@Bean
	public Docket createRestApi() {		
		return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
				.apis(RequestHandlerSelectors.basePackage("com.lpy.controller"))
				.paths(PathSelectors.any()).build();
	}
	/**
	 * @Description: 構建 api文檔的信息
	 */
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				// 設置頁面標題
				.title("使用swagger2構建短視頻後端api接口文檔")
				// 設置聯繫人
				.contact(new Contact("Richard", "http://www.lpy.com", "[email protected]"))
				// 描述
				.description("歡迎訪問短視頻接口文檔，這裏是描述信息")
				// 定義版本號
				.version("1.0").build();
	}
 
}

第二步：給接口寫註解

package com.lpy.controller;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import com.lpy.pojo.Users;
import com.lpy.service.UserService;
import com.lpy.utils.LpyJSONResult;
import com.lpy.utils.MD5Utils;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
/**
 * @RestController表示已json格式進行傳遞
 * @RequestBody表示將json對象轉換成對象
 * @author Richard
 */
@RestController
@Api(value="用戶註冊登陸的接口",tags= {"註冊和登陸的controller"})
public class RegistLoginController {
	//注入service
	@Autowired
	private UserService userService;
	
	@ApiOperation(value="用戶註冊",notes="用戶註冊的接口")
	@PostMapping("/regist")
	public LpyJSONResult regist(@RequestBody Users user) throws Exception {
		//1、判斷用戶名和密碼必須不爲空
		if(StringUtils.isBlank(user.getUsername())||StringUtils.isBlank(user.getPassword())) {
			return LpyJSONResult.errorMsg("用戶名和密碼不能爲空");
		}
		//2、判斷用戶名是否存在
		boolean usernameIsExist=userService.queryUsernameIsExist(user.getUsername());
		//3、保存用戶，註冊信息
		if(!usernameIsExist) {
			user.setNickname(user.getUsername());//暱稱
			user.setPassword(MD5Utils.getMD5Str(user.getPassword()));//密碼
			user.setFansCounts(0);//粉絲數
			user.setReceiveLikeCounts(0);//喜歡的數
			user.setFollowCounts(0);//追隨數
			userService.saveUser(user);
		}else {
			return LpyJSONResult.errorMsg("用戶名已經存在，請換一個再試");
		}	
		return LpyJSONResult.ok();
	}	
}

第三步：給實體類寫註解

package com.lpy.pojo;
 
import javax.persistence.*;
 
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
@ApiModel(value="用戶對象",description="這是用戶對象")
public class Users {
	@ApiModelProperty(hidden=true)
    @Id
    private String id;
	
    @ApiModelProperty(value="用戶名",name="username",example="lpyuser",required=true)
    private String username;
    
    @ApiModelProperty(value="密碼",name="password",example="123456",required=true)
    private String password;
    
 
    /**
     * @return id
     */
    public String getId() {
        return id;
    }
 
    /**
     * @param id
     */
    public void setId(String id) {
        this.id = id;
    }
 
    /**
     * @return username
     */
    public String getUsername() {
        return username;
    }
 
}