add 整合 springdoc-openapi-javadoc 基于代码注释生成文档

疯狂的狮子li

2022-07-07 d9e54388e7fde2462e8b7e0165c5e7da3f202593

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

@@ -1,10 +1,10 @@
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 com.ruoyi.common.core.domain.R;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.Parameters;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestPart;
@@ -16,7 +16,7 @@
 *
 * @author Lion Li
 */
@Api(value = "演示swagger3控制器", tags = {"演示swagger3接口"})
@Tag(name ="演示swagger3控制器", description = "演示swagger3接口")
@RestController
@RequestMapping("/swagger/demo")
public class Swagger3DemoController {
@@ -24,15 +24,13 @@
    /**
     * 上传请求
     * 必须使用 @RequestPart 注解标注为文件
     * dataType 必须为 "java.io.File"
     */
    @ApiOperation(value = "通用上传请求")
    @ApiImplicitParams({
        @ApiImplicitParam(name = "file", value = "文件", dataType = "java.io.File", required = true),
    @Parameters({
        @Parameter(name = "file", description = "文件", in = ParameterIn.QUERY, required = true)
    })
    @PostMapping(value = "/upload")
    public AjaxResult<String> upload(@RequestPart("file") MultipartFile file) {
        return AjaxResult.success("操作成功", file.getOriginalFilename());
    public R<String> upload(@RequestPart("file") MultipartFile file) {
        return R.ok("操作成功", file.getOriginalFilename());
    }

}