Rest接口Call InvokeCallParams方法文档示例和说明.xml 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <apis>
  3. <api>
  4. <!-- 接口名称 -->
  5. <methodName>测试api</methodName>
  6. <!-- 排序 -->
  7. <sort>10</sort>
  8. <!-- 使用的脚本业务名称 不要BE_ -->
  9. <businessMethod>Express_aaaa</businessMethod>
  10. <!-- 是否需要token,留着空表示不需要,需要token的写上获取token的方法,不能不要该节点 -->
  11. <tokenFrom></tokenFrom>
  12. <!-- 是否需要分页,留着空表示不需要,随便写的啥表示需要分页参数,不能不要该节点 -->
  13. <pageFrom>1</pageFrom>
  14. <!--
  15. 参数信息,paramOnly和params是互斥的,有的时候我们需要的参数是单个类的json就完事,但是又懒得一个一个写param,可以只用paramOnly标识,里面输入带包类名,
  16. 然后在类里面用@ApiPlce("脚本业务名称")标记上需要的字段即可,不能不要该节点,使用params时,paramOnly写空即可。
  17. -->
  18. <paramOnly></paramOnly>
  19. <!--
  20. 参数信息,
  21. -->
  22. <params>
  23. <param>
  24. <!-- 参数说明 -->
  25. <paramComment>参数1</paramComment>
  26. <!-- 参数名称 -->
  27. <paramKey>keyWord1</paramKey>
  28. <!-- 参数类型 "Integer", "Long", "Double", "Float", "Boolean", "String" 为基础类型 -->
  29. <paramKind>Integer</paramKind>
  30. </param>
  31. <param>
  32. <paramComment>参数2</paramComment>
  33. <paramKey>keyWord2</paramKey>
  34. <paramKind>String</paramKind>
  35. </param>
  36. <param>
  37. <paramComment>参数3</paramComment>
  38. <paramKey>keyWord3</paramKey>
  39. <!-- 参数类型 为类时,文档会读取注解@ApiPlce("脚本业务名称")的字段生成参数表 -->
  40. <paramKind>com.yinjie.heating.common.entity.order.BusinessOrder</paramKind>
  41. </param>
  42. <param>
  43. <paramComment>参数4</paramComment>
  44. <paramKey>keyWord4</paramKey>
  45. <paramKind>com.yinjie.heating.common.entity.order.OrderAfterSaleBill</paramKind>
  46. </param>
  47. </params>
  48. <!-- 类说明,文档会生成类的说明表格 -->
  49. <webApiBean>com.yinjie.heating.common.entity.order.OrderAfterSaleBill</webApiBean>
  50. <webApiBean>com.yinjie.heating.common.entity.order.OrderDeliveryInfo</webApiBean>
  51. </api>
  52. <api>
  53. <methodName>创建配送单</methodName>
  54. <sort>11</sort>
  55. <businessMethod>Express_bbbbb</businessMethod>
  56. <tokenFrom>/order/orderFormToken</tokenFrom>
  57. <pageFrom></pageFrom>
  58. <paramOnly>com.yinjie.heating.common.entity.order.BusinessOrder</paramOnly>
  59. <webApiBean></webApiBean>
  60. </api>
  61. </apis>