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

疯狂的狮子li

2022-07-07 d9e54388e7fde2462e8b7e0165c5e7da3f202593

 ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysLogininforController.java

@@ -1,67 +1,63 @@
package com.ruoyi.web.controller.monitor;



import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.security.access.prepost.PreAuthorize;

import org.springframework.web.bind.annotation.DeleteMapping;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

import com.ruoyi.common.annotation.Log;

import com.ruoyi.common.core.controller.BaseController;

import com.ruoyi.common.core.domain.AjaxResult;

import com.ruoyi.common.core.page.TableDataInfo;

import com.ruoyi.common.enums.BusinessType;

import com.ruoyi.common.utils.poi.ExcelUtil;

import com.ruoyi.system.domain.SysLogininfor;

import com.ruoyi.system.service.ISysLogininforService;



/**

 * 系统访问记录

 * 
 * @author ruoyi

 */

@RestController

@RequestMapping("/monitor/logininfor")

public class SysLogininforController extends BaseController

{

    @Autowired

    private ISysLogininforService logininforService;



    @PreAuthorize("@ss.hasPermi('monitor:logininfor:list')")

    @GetMapping("/list")

    public TableDataInfo list(SysLogininfor logininfor)

    {

        startPage();

        List<SysLogininfor> list = logininforService.selectLogininforList(logininfor);

        return getDataTable(list);

    }



    @Log(title = "登陆日志", businessType = BusinessType.EXPORT)

    @PreAuthorize("@ss.hasPermi('monitor:logininfor:export')")

    @GetMapping("/export")

    public AjaxResult export(SysLogininfor logininfor)

    {

        List<SysLogininfor> list = logininforService.selectLogininforList(logininfor);

        ExcelUtil<SysLogininfor> util = new ExcelUtil<SysLogininfor>(SysLogininfor.class);

        return util.exportExcel(list, "登陆日志");

    }



    @PreAuthorize("@ss.hasPermi('monitor:logininfor:remove')")

    @Log(title = "登陆日志", businessType = BusinessType.DELETE)

    @DeleteMapping("/{infoIds}")

    public AjaxResult remove(@PathVariable Long[] infoIds)

    {

        return toAjax(logininforService.deleteLogininforByIds(infoIds));

    }



    @PreAuthorize("@ss.hasPermi('monitor:logininfor:remove')")

    @Log(title = "登陆日志", businessType = BusinessType.CLEAN)

    @DeleteMapping("/clean")

    public AjaxResult clean()

    {

        logininforService.cleanLogininfor();

        return AjaxResult.success();

    }

}

package com.ruoyi.web.controller.monitor;

import cn.dev33.satoken.annotation.SaCheckPermission;
import com.ruoyi.common.annotation.Log;
import com.ruoyi.common.core.controller.BaseController;
import com.ruoyi.common.core.domain.PageQuery;
import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.core.page.TableDataInfo;
import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.domain.SysLogininfor;
import com.ruoyi.system.service.ISysLogininforService;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.servlet.http.HttpServletResponse;
import java.util.List;

/**
 * 系统访问记录
 *
 * @author Lion Li
 */
@Validated
@Tag(name ="系统访问记录", description = "系统访问记录管理")
@RequiredArgsConstructor
@RestController
@RequestMapping("/monitor/logininfor")
public class SysLogininforController extends BaseController {

    private final ISysLogininforService logininforService;

    @SaCheckPermission("monitor:logininfor:list")
    @GetMapping("/list")
    public TableDataInfo<SysLogininfor> list(SysLogininfor logininfor, PageQuery pageQuery) {
        return logininforService.selectPageLogininforList(logininfor, pageQuery);
    }

    @Log(title = "登录日志", businessType = BusinessType.EXPORT)
    @SaCheckPermission("monitor:logininfor:export")
    @PostMapping("/export")
    public void export(SysLogininfor logininfor, HttpServletResponse response) {
        List<SysLogininfor> list = logininforService.selectLogininforList(logininfor);
        ExcelUtil.exportExcel(list, "登录日志", SysLogininfor.class, response);
    }

    @SaCheckPermission("monitor:logininfor:remove")
    @Log(title = "登录日志", businessType = BusinessType.DELETE)
    @DeleteMapping("/{infoIds}")
    public R<Void> remove(@PathVariable Long[] infoIds) {
        return toAjax(logininforService.deleteLogininforByIds(infoIds));
    }

    @SaCheckPermission("monitor:logininfor:remove")
    @Log(title = "登录日志", businessType = BusinessType.CLEAN)
    @DeleteMapping("/clean")
    public R<Void> clean() {
        logininforService.cleanLogininfor();
        return R.ok();
    }
}