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自定义扩展字段
 appIdStringappId
 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
 uuidStringuuid