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

疯狂的狮子li

2022-07-07 d9e54388e7fde2462e8b7e0165c5e7da3f202593

 ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysNoticeController.java

@@ -1,91 +1,79 @@
package com.ruoyi.web.controller.system;



import java.util.List;

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

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

import org.springframework.validation.annotation.Validated;

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.PostMapping;

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

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

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.system.domain.SysNotice;

import com.ruoyi.system.service.ISysNoticeService;



/**

 * 公告 信息操作处理

 * 
 * @author ruoyi

 */

@RestController

@RequestMapping("/system/notice")

public class SysNoticeController extends BaseController

{

    @Autowired

    private ISysNoticeService noticeService;



    /**

     * 获取通知公告列表

     */

    @PreAuthorize("@ss.hasPermi('system:notice:list')")

    @GetMapping("/list")

    public TableDataInfo list(SysNotice notice)

    {

        startPage();

        List<SysNotice> list = noticeService.selectNoticeList(notice);

        return getDataTable(list);

    }



    /**

     * 根据通知公告编号获取详细信息

     */

    @PreAuthorize("@ss.hasPermi('system:notice:query')")

    @GetMapping(value = "/{noticeId}")

    public AjaxResult getInfo(@PathVariable Long noticeId)

    {

        return AjaxResult.success(noticeService.selectNoticeById(noticeId));

    }



    /**

     * 新增通知公告

     */

    @PreAuthorize("@ss.hasPermi('system:notice:add')")

    @Log(title = "通知公告", businessType = BusinessType.INSERT)

    @PostMapping

    public AjaxResult add(@Validated @RequestBody SysNotice notice)

    {

        notice.setCreateBy(getUsername());

        return toAjax(noticeService.insertNotice(notice));

    }



    /**

     * 修改通知公告

     */

    @PreAuthorize("@ss.hasPermi('system:notice:edit')")

    @Log(title = "通知公告", businessType = BusinessType.UPDATE)

    @PutMapping

    public AjaxResult edit(@Validated @RequestBody SysNotice notice)

    {

        notice.setUpdateBy(getUsername());

        return toAjax(noticeService.updateNotice(notice));

    }



    /**

     * 删除通知公告

     */

    @PreAuthorize("@ss.hasPermi('system:notice:remove')")

    @Log(title = "通知公告", businessType = BusinessType.DELETE)

    @DeleteMapping("/{noticeIds}")

    public AjaxResult remove(@PathVariable Long[] noticeIds)

    {

        return toAjax(noticeService.deleteNoticeByIds(noticeIds));

    }

}

package com.ruoyi.web.controller.system;

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.system.domain.SysNotice;
import com.ruoyi.system.service.ISysNoticeService;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

/**
 * 公告 信息操作处理
 *
 * @author Lion Li
 */
@Validated
@Tag(name ="公告信息控制器", description = "公告信息管理")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/notice")
public class SysNoticeController extends BaseController {

    private final ISysNoticeService noticeService;

    /**
     * 获取通知公告列表
     */
    @SaCheckPermission("system:notice:list")
    @GetMapping("/list")
    public TableDataInfo<SysNotice> list(SysNotice notice, PageQuery pageQuery) {
        return noticeService.selectPageNoticeList(notice, pageQuery);
    }

    /**
     * 根据通知公告编号获取详细信息
     */
    @SaCheckPermission("system:notice:query")
    @GetMapping(value = "/{noticeId}")
    public R<SysNotice> getInfo(@Parameter(name = "公告ID") @PathVariable Long noticeId) {
        return R.ok(noticeService.selectNoticeById(noticeId));
    }

    /**
     * 新增通知公告
     */
    @SaCheckPermission("system:notice:add")
    @Log(title = "通知公告", businessType = BusinessType.INSERT)
    @PostMapping
    public R<Void> add(@Validated @RequestBody SysNotice notice) {
        return toAjax(noticeService.insertNotice(notice));
    }

    /**
     * 修改通知公告
     */
    @SaCheckPermission("system:notice:edit")
    @Log(title = "通知公告", businessType = BusinessType.UPDATE)
    @PutMapping
    public R<Void> edit(@Validated @RequestBody SysNotice notice) {
        return toAjax(noticeService.updateNotice(notice));
    }

    /**
     * 删除通知公告
     */
    @SaCheckPermission("system:notice:remove")
    @Log(title = "通知公告", businessType = BusinessType.DELETE)
    @DeleteMapping("/{noticeIds}")
    public R<Void> remove(@Parameter(name = "公告ID串") @PathVariable Long[] noticeIds) {
        return toAjax(noticeService.deleteNoticeByIds(noticeIds));
    }
}