add 增加 Swagger3 用法示例

疯狂的狮子li

2021-06-23 152a386ac1d64e42838b893190d773d8874a6406

add 增加 Swagger3 用法示例

 ruoyi-demo/src/main/java/com/ruoyi/demo/controller/Swagger3DemoController.java

¶Ô±ÈÐÂÎļþ
@@ -0,0 +1,38 @@
package com.ruoyi.demo.controller;

import com.ruoyi.common.core.domain.AjaxResult;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestPart;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

/**
 * swagger3 ç”¨æ³•ç¤ºä¾‹
 *
 * @author Lion Li
 */
@Api(value = "演示swagger3控制器", tags = {"演示swagger3接口"})
@RestController
@RequestMapping("/swagger/demo")
public class Swagger3DemoController {

    /**
     * ä¸Šä¼ è¯·æ±‚
     * å¿…须使用 @RequestPart æ³¨è§£æ ‡æ³¨ä¸ºæ–‡ä»¶
     * dataType å¿…须为 "java.io.File"
     */
    @ApiOperation(value = "通用上传请求")
    @ApiImplicitParams({
        @ApiImplicitParam(name = "file", value = "文件", dataType = "java.io.File", required = true),
    })
    @PostMapping(value = "/upload")
    public AjaxResult<String> upload(@RequestPart("file") MultipartFile file) {
        return AjaxResult.success("操作成功", file.getOriginalFilename());
    }

}