ApiDoc.md.tp 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  1. {if condition="array_key_exists('select',$crud)"}
  2. # 查询{$menuName}
  3. 接口地址:/api/{$underLineName}/index
  4. 请求方式:get / post
  5. 请求数据:
  6. | 参数名 | 说明 | 备注 |
  7. | --- | --- | --- |
  8. | id | 指定ID,则只返回一条数据 | int |
  9. | page | 第几页,默认1 | int |
  10. | pagenum | 每页几条,默认20 | int,<=:1000 |
  11. 响应数据:(json格式)
  12. ```
  13. {
  14. "code": 1, // 返回状态,1代表成功,0代表失败
  15. "msg": "success", // 返回消息
  16. "time": "1586490789", // 响应时间戳
  17. "data": null // 结果数据,json格式,没数据时为 null
  18. }
  19. ```
  20. {/if}
  21. {if condition="array_key_exists('create',$crud)"}
  22. # 新增{$menuName}
  23. 接口地址:/api/{$underLineName}/create
  24. 请求方式:get / post
  25. 请求数据:
  26. | 参数名 | 说明 | 备注 |
  27. | --- | --- | --- |
  28. {volist name="$fieldsInfo" id="vo"}
  29. {php}
  30. $field_key = $vo['Field'];
  31. if(in_array($field_key,['id','create_time','update_time'])){
  32. continue;
  33. }
  34. if(!empty($vo['Comment'])){
  35. $comment = $vo['Comment'];
  36. $field_key.= " | " . $comment;
  37. }else{
  38. $field_key.= " | ";
  39. }
  40. $field_val = "";
  41. if($vo['Default'] === null){
  42. $field_val.= "require";
  43. }
  44. if(startWith($vo["Type"],'int') || startWith($vo["Type"],'tinyint')){
  45. $field_val .= empty($field_val) ? "int" : ",int";
  46. }
  47. if(startWith($vo["Type"],'varchar')){
  48. $maxLen = str_replace(['varchar(',')'],['',''],$vo["Type"]);
  49. $field_val .= empty($field_val) ? "max:".$maxLen : ",max:".$maxLen;
  50. }
  51. {/php}
  52. {notempty name="$field_val"}
  53. | {$field_key} | {$field_val} |
  54. {/notempty}
  55. {/volist}
  56. 响应数据:(json格式)
  57. ```
  58. {
  59. "code": 1, // 返回状态,1代表成功,0代表失败
  60. "msg": "success", // 返回消息
  61. "time": "1586490789", // 响应时间戳
  62. "data": null // 结果数据,json格式,没数据时为 null
  63. }
  64. ```
  65. {/if}
  66. {if condition="array_key_exists('delete',$crud)"}
  67. # 删除{$menuName}
  68. 接口地址:/api/{$underLineName}/delete
  69. 请求方式:get / post
  70. 请求数据:
  71. | 参数名 | 说明 | 备注 |
  72. | --- | --- | --- |
  73. | id | 数据ID | int |
  74. 响应数据:(json格式)
  75. ```
  76. {
  77. "code": 1, // 返回状态,1代表成功,0代表失败
  78. "msg": "success", // 返回消息
  79. "time": "1586490789", // 响应时间戳
  80. "data": null // 结果数据,json格式,没数据时为 null
  81. }
  82. ```
  83. {/if}
  84. {if condition="array_key_exists('update',$crud)"}
  85. # 修改{$menuName}
  86. 接口地址:/api/{$underLineName}/update
  87. 请求方式:get / post
  88. 请求数据:
  89. | 参数名 | 说明 | 备注 |
  90. | --- | --- | --- |
  91. | id | 数据ID | int |
  92. {volist name="$fieldsInfo" id="vo"}
  93. {php}
  94. $field_key = $vo['Field'];
  95. if(in_array($field_key,['id','create_time','update_time'])){
  96. continue;
  97. }
  98. if($vo['Default'] === null){
  99. continue;
  100. }
  101. if(!empty($vo['Comment'])){
  102. $comment = $vo['Comment'];
  103. $field_key.= " | " . $comment;
  104. }else{
  105. $field_key.= " | ";
  106. }
  107. $field_val = "";
  108. if(startWith($vo["Type"],'int') || startWith($vo["Type"],'tinyint')){
  109. $field_val .= empty($field_val) ? "int" : ",int";
  110. }
  111. if(startWith($vo["Type"],'varchar')){
  112. $maxLen = str_replace(['varchar(',')'],['',''],$vo["Type"]);
  113. $field_val .= empty($field_val) ? "max:".$maxLen : ",max:".$maxLen;
  114. }
  115. {/php}
  116. {notempty name="$field_val"}
  117. | {$field_key} | {$field_val} |
  118. {/notempty}
  119. {/volist}
  120. 响应数据:(json格式)
  121. ```
  122. {
  123. "code": 1, // 返回状态,1代表成功,0代表失败
  124. "msg": "success", // 返回消息
  125. "time": "1586490789", // 响应时间戳
  126. "data": null // 结果数据,json格式,没数据时为 null
  127. }
  128. ```
  129. {/if}