jetplugins / apidocx

Generate API documents to any place: YApi, RAP2, Eolink, etc.
https://plugins.jetbrains.com/plugin/17425-apidocx/
Apache License 2.0
177 stars 39 forks source link

请求参数导入到yapi中,示例栏取得是@RequestParam的defaultValue属性对应的值 #46

Open whiteS18 opened 1 year ago

whiteS18 commented 1 year ago

使用插件导入到yapi中后,请求参数那一块,示例这一栏取得是代码中 @RequestParam 注解中defaultValue属性对应的值,但是如果defaultValue为空,示例就不会显示内容了,如果要写示例值就只能写在注释那里了,有什么其他方法来实现吗?

lkqm commented 1 year ago

可以通过Javadoc文档注释来实现,对应上传后显示到 参数备注里面,例子:

/**
 * @param code 用户编码(例: CC)
 */
whiteS18 commented 1 year ago

还有一个问题是:如果我返回的是entity类,那么返回的对象里面会包含一个entityClass,这个有什么配置可以去掉嘛?

whiteS18 commented 1 year ago

@lkqm 这个知道,就是生成出来的文档看着怪怪的,明明应该是放在示例那一栏结果却放在了备注,可能我有强迫症hhh

lkqm commented 1 year ago

还有一个问题是:如果我返回的是entity类,那么返回的对象里面会包含一个entityClass,这个有什么配置可以去掉嘛?

应该是对于某些类型,没有指定 描述时,会自动填充类名,目前没有办法配置去除掉

whiteS18 commented 1 year ago

还有一个问题是:如果我返回的是entity类,那么返回的对象里面会包含一个entityClass,这个有什么配置可以去掉嘛?

应该是对于某些类型,没有指定 描述时,会自动填充类名,目前没有办法配置去除掉

我是指的如红色框起来的这一部分,我在代码中类对象上面加了描述,但是还是会有entityClass这个对象 图片 图片

lkqm commented 1 year ago

明白了相当于父类的某个字段不要,目前没办法配置父类来去除,这个问题后续会修复,以支持排除掉父类的某个字段