【自动生成】使用IDEA的Apidocx插件在rap生成接口文档

文章介绍了一种通过注解自动化生成接口文档的方法,可以减少手动编写文档的时间。开发者只需在代码中添加特定注解,如@menu用于配置模板名称,然后使用特定插件,如Apidocx,结合配置文件,就能自动生成接口文档并上传至YApi、Rap2等工具。这种方法强调注释的完整性和规范性,以确保文档质量。
摘要由CSDN通过智能技术生成

你是否苦于接口文档写完后自己再去建bean,不断ctrl+c,ctrl+v;有时候项目比较赶需要快速完成接口开发但有浪费很多时间在写接口文档上面,如果你有这些问题,那么下面的方式也许可以解决你的燃眉之急!!!

一、生成接口文档最终效果

 

 

二、实现方式

/**
 * @author xxx
 * @menu test模板名称
 */
@Slf4j
@RequestMapping("/ces/test")
@RestController
public class AddStoreController{
    @Autowired
    private BcpAddStoreService bcpAddStoreService;

    /**
     * test接口名称
     *
     * @param param
     * @return
     */
    @PostMapping("queryTestApiDocx")
    public StoreInventoryPrdListVO queryTestApiDocx(@RequestBody @Valid StoreStockQueryDTO param) {
        retu
  • 4
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 4
    评论
评论 4
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

码上花开

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值