接口文档生成
在代码区调用插件生成接口文档,鼠标光标可以放在接口类名称上或着方法名称中,右键选择JoyCoder -> 接口文档生成。
生成结果为markdown格式,通过插件自带的展示markdown功能可以看到渲染效果。
以下为接口文档生成结果示例:
方法描述: 提交问诊订单
请求参数:
入参1
| 参数名 | 参数类型 | 是否必选 | 参数说明 |
|---|---|---|---|
| inquiryOrderDTO | InquiryOrderDTO | 是 | 问诊订单DTO |
| businessType | Integer | 是 | 医生服务类型 |
| serviceType | Integer | 是 | 医生服务业务类型,如电话、图文等 |
| userPin | String | 是 | 用户pin |
| patientId | Long | 是 | 患者id |
| diseaseDesc | String | 是 | 病情描述 |
| diseasePic | String | 是 | 病情图片 |
| skuId | Long | 是 | 医生服务skuId |
| venderId | Long | 是 | 租户id |
| channel | Integer | 是 | 支付渠道,微信为5 |
| payType | Integer | 是 | 支付类型,1为货到付款,4为自费支付 |
| businessExtendData | String | 是 | 自定义扩展字段 |
| appId | String | 是 | appId |
| scheduleId | Long | 是 | 电话问诊排班id |
| appointmentPhone | String | 是 | 电话 |
| actionNo | String | 是 | 锁号id |
| beneficialId | String | 是 | 权益id |
| inquiryTenancyId | String | 是 | 租户id,如卫材JD1000 |
| aresChannel | Integer | 是 | 渠道 |
| scene | String | 是 | 下单业务场景 |
| drugSkuId | Long | 是 | 商品信息 |
| departCode | String | 是 | 视频用科室编码 |
| departLevel | Integer | 是 | 视频用科室级别 |
| departName | String | 是 | 科室名称 |
| source | Integer | 是 | 下单渠道码 |
| activityBusinessScene | String | 是 | 活动业务场景,用于问诊下单 |
| activityId | Long | 是 | 活动编号 |
| activityName | String | 是 | 活动名称 |
| tenantId | String | 是 | 阿瑞斯租户id |
| triageDepCode | String | 是 | 分诊科室code |
| triageUUID | String | 是 | 分诊UUID |
| payTimeOut | Date | 是 | 待支付时长 |
响应参数:
| 参数名 | 参数类型 | 是否必选 | 参数说明 |
|---|---|---|---|
| 返回值 | JsfResult<DiagOrderSubmitDTO> | 是 | 返回结果 |
| serialVersionUID | long | 是 | 序列化版本uid |
| code | String | 是 | 返回值 |
| msg | String | 是 | 错误信息 |
| data | DiagOrderSubmitDTO | 是 | 问诊订单提交结果 |
| resultCode | int | 是 | 结果Code |
| resultFlag | boolean | 是 | 成功标志 |
| message | String | 是 | 通用下单标志 |
| orderId | long | 是 | 订单号 |
| submitSkuNum | int | 是 | 提交SKU的数量 |
| orderInfo | String | 是 | 订单信息 |
| cartInfo | String | 是 | 购物车信息 |
| noStockSkuList | Set<Long> | 是 | 库存数量 |
| whatYouWant | Map<String, Object> | 是 | 自定义数据 |
| diagId | long | 是 | 问诊单Id |
| uuid | String | 是 | uuid |