Skip to main content

接口文档生成

在代码区调用插件生成接口文档,鼠标光标可以放在接口类名称上或着方法名称中,右键选择JoyCoder -> 接口文档生成。

生成结果为markdown格式,通过插件自带的展示markdown功能可以看到渲染效果。

以下为接口文档生成结果示例:

方法描述: 提交问诊订单

请求参数:

入参1

参数名参数类型是否必选参数说明
inquiryOrderDTOInquiryOrderDTO是问诊订单DTO
 businessTypeInteger是医生服务类型
 serviceTypeInteger是医生服务业务类型,如电话、图文等
 userPinString是用户pin
 patientIdLong是患者id
 diseaseDescString是病情描述
 diseasePicString是病情图片
 skuIdLong是医生服务skuId
 venderIdLong是租户id
 channelInteger是支付渠道,微信为5
 payTypeInteger是支付类型,1为货到付款,4为自费支付
 businessExtendDataString是自定义扩展字段
 appIdString是appId
 scheduleIdLong是电话问诊排班id
 appointmentPhoneString是电话
 actionNoString是锁号id
 beneficialIdString是权益id
 inquiryTenancyIdString是租户id,如卫材JD1000
 aresChannelInteger是渠道
 sceneString是下单业务场景
 drugSkuIdLong是商品信息
 departCodeString是视频用科室编码
 departLevelInteger是视频用科室级别
 departNameString是科室名称
 sourceInteger是下单渠道码
 activityBusinessSceneString是活动业务场景,用于问诊下单
 activityIdLong是活动编号
 activityNameString是活动名称
 tenantIdString是阿瑞斯租户id
 triageDepCodeString是分诊科室code
 triageUUIDString是分诊UUID
 payTimeOutDate是待支付时长

响应参数:

参数名参数类型是否必选参数说明
返回值JsfResult<DiagOrderSubmitDTO>是返回结果
 serialVersionUIDlong是序列化版本uid
 codeString是返回值
 msgString是错误信息
 dataDiagOrderSubmitDTO是问诊订单提交结果
  resultCodeint是结果Code
  resultFlagboolean是成功标志
  messageString是通用下单标志
  orderIdlong是订单号
  submitSkuNumint是提交SKU的数量
  orderInfoString是订单信息
  cartInfoString是购物车信息
  noStockSkuListSet<Long>是库存数量
  whatYouWantMap<String, Object>是自定义数据
  diagIdlong是问诊单Id
 uuidString是uuid