Swagger相关使用

变量参数注解说明

import com.ctfo.api.model.req.BaseParam;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

@Data
@ApiModel(description = "换肤参数")
public class ThemeParam extends BaseParam{
	
	 @ApiModelProperty(name = "name", value = "颜色名称")
	 private String name;
	 
	 @ApiModelProperty(name = "config", value = "皮肤颜色配置")
	 private String config;
}

 

Action注解说明

@Slf4j
@RestController
@ApiResource(name = "系统操作相关接口", path = "/api/system")
@Api(tags = {"系统操作相关接口"})
public class SystemController {
    
    @PostResource(name = "分享", path = "/share", requiredLogin = false, requiredPermission = false)
    @ApiOperation(value = "分享")
    public Response<ShareVo> share(@Valid @RequestBody Request<ShareParam> request) {
    	
    }
    
    @GetResource(name = "分享访问", path = "/shareAccess", requiredLogin = false, requiredPermission = false)
    @ApiOperation(value = "分享访问")
    public Response<ShareAccessVo> shareAccess(@Valid @RequestParam String shareToken) {
    	
    }
    
    @PostResource(name = "换肤", path = "/theme", requiredLogin = false, requiredPermission = false)
    @ApiOperation(value = "换肤")
    public Response<ThemeVo> theme(@Valid @RequestBody Request<ThemeParam> request) {
    	
    }
    
}