经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » 程序设计 » PHP » 查看文章
接口文档神器--apiui的使用
来源:cnblogs  作者:瞪眼看太阳  时间:2018/10/8 9:13:58  对本文有异议

接口开发,最麻烦的就是写文档了,曾经我也因为写接口文档苦不堪言;自从使用了apiui接口文档神器,工作效率和文档清晰得到了不止一个档次的提升。

下面介绍一下这个神器的使用:

把文件下载下来,放在网站根目录;

链接:https://pan.baidu.com/s/1DaT_rUANaSoHVhy8BjtQRw 密码:atgu

更改index.html文件的三个参数;

然后打开api.json文件,添加对应的接口模块;

  1. 1 {
  2. 2 "apiVersion":"0.2",
  3. 3 "swaggerVersion":"1.1",
  4. 4 "apis":[
  5. 5 {
  6. 6 "path":"/fellow.{format}",
  7. 7 "description":"会员详情"
  8. 8 },
  9. 9 {
  10. 10 "path":"/red_packet.{format}",
  11. 11 "description":"红包"
  12. 12 }
  13. 13
  14. 14 ]
  15. 15 }

apis下面一组数据对应就是一个模块;

path参数是模块名,description参数是模块别名,一个模块对应api文件夹下的一个json文件;

 

 然后就编辑api下面的json文件,

  1. 1 {
  2. 2 "apiVersion":"0.2",
  3. 3 "swaggerVersion":"1.1",
  4. 4 "resourcePath":"/",
  5. 5 "apis":[
  6. 6 {
  7. 7 "path":"/fellow_info",
  8. 8 "operations":[
  9. 9 {
  10. 10 "description":"",
  11. 11 "updateTime":"2018/4/12 22:17",
  12. 12 "httpMethod":"GET",
  13. 13 "summary":"会员资料",
  14. 14 "apiStatus":2,
  15. 15 "reviser":"完成",
  16. 16 "responseClass":"void",
  17. 17 "nickname":"test0",
  18. 18 "revisionHighlight":true,
  19. 19 "fieldDesc":{
  20. 20 "result@string":"请求返回的状态1成功0失败",
  21. 21 "message@string":"提示信息",
  22. 22 "data@string":"返回的数据",
  23. 23 "nickname@string":"昵称",
  24. 24 "sex@string":"性别",
  25. 25 "tel@string":"手机号",
  26. 26 "label@string":"标签",
  27. 27 "remark@string":"备注",
  28. 28 "industry@string":"行业",
  29. 29 "company@string":"所在公司",
  30. 30 "position@string":"职位",
  31. 31 "region@string":"地区",
  32. 32 "email@string":"邮箱",
  33. 33 "qq_account@string":"QQ号",
  34. 34 "wx_account@string":"微信号",
  35. 35 "identity@string":"身份"
  36. 36
  37. 37 },
  38. 38 "parameters":[
  39. 39
  40. 40 {
  41. 41 "description":"用户id",
  42. 42 "paramType":"body",
  43. 43 "required":true,
  44. 44 "allowMultiple":false,
  45. 45 "dataType":"uid"
  46. 46 }
  47. 47 ]
  48. 48 }
  49. 49 ]
  50. 50 },
  51. 51 {
  52. 52 "path":"/upd_fellow_info",
  53. 53 "operations":[
  54. 54 {
  55. 55 "description":"",
  56. 56 "updateTime":"2018/4/12 22:17",
  57. 57 "httpMethod":"GET",
  58. 58 "summary":"编辑会员资料",
  59. 59 "apiStatus":2,
  60. 60 "reviser":"完成",
  61. 61 "responseClass":"void",
  62. 62 "nickname":"test1",
  63. 63 "revisionHighlight":true,
  64. 64 "fieldDesc":{
  65. 65 "result@string":"请求返回的状态1成功0失败",
  66. 66 "message@string":"提示信息",
  67. 67 "data@string":"返回的数据"
  68. 68
  69. 69 },
  70. 70 "parameters":[
  71. 71
  72. 72 {
  73. 73 "description":"用户id",
  74. 74 "paramType":"body",
  75. 75 "required":true,
  76. 76 "allowMultiple":false,
  77. 77 "dataType":"uid",
  78. 78 "defaultValue":"81"
  79. 79 },
  80. 80 {
  81. 81 "description":"代理商id",
  82. 82 "paramType":"body",
  83. 83 "required":true,
  84. 84 "allowMultiple":false,
  85. 85 "dataType":"aid",
  86. 86 "defaultValue":"164"
  87. 87 },
  88. 88 {
  89. 89 "description":"姓名",
  90. 90 "paramType":"body",
  91. 91 "required":false,
  92. 92 "allowMultiple":false,
  93. 93 "dataType":"nickname",
  94. 94 "defaultValue":"邓丽君"
  95. 95 },
  96. 96 {
  97. 97 "description":"性别(填男,女,未知)",
  98. 98 "paramType":"body",
  99. 99 "required":false,
  100. 100 "allowMultiple":false,
  101. 101 "dataType":"sex",
  102. 102 "defaultValue":"女"
  103. 103 },
  104. 104 {
  105. 105 "description":"手机号",
  106. 106 "paramType":"body",
  107. 107 "required":false,
  108. 108 "allowMultiple":false,
  109. 109 "dataType":"tel",
  110. 110 "defaultValue":"13800138000"
  111. 111 },
  112. 112 {
  113. 113 "description":"标签,(传标签名,多个标签时候用,分开)",
  114. 114 "paramType":"body",
  115. 115 "required":false,
  116. 116 "allowMultiple":false,
  117. 117 "dataType":"label",
  118. 118 "defaultValue":"经理,2月生日"
  119. 119 },
  120. 120 {
  121. 121 "description":"备注",
  122. 122 "paramType":"body",
  123. 123 "required":false,
  124. 124 "allowMultiple":false,
  125. 125 "dataType":"remark",
  126. 126 "defaultValue":"她是好人我是好人这是备注"
  127. 127 },
  128. 128 {
  129. 129 "description":"行业(传行业id)",
  130. 130 "paramType":"body",
  131. 131 "required":false,
  132. 132 "allowMultiple":false,
  133. 133 "dataType":"industry",
  134. 134 "defaultValue":"4"
  135. 135 },
  136. 136 {
  137. 137 "description":"公司",
  138. 138 "paramType":"body",
  139. 139 "required":false,
  140. 140 "allowMultiple":false,
  141. 141 "dataType":"company",
  142. 142 "defaultValue":"嘻哈唱片有限公司"
  143. 143 },
  144. 144 {
  145. 145 "description":"职位",
  146. 146 "paramType":"body",
  147. 147 "required":false,
  148. 148 "allowMultiple":false,
  149. 149 "dataType":"position",
  150. 150 "defaultValue":"演员"
  151. 151 },
  152. 152 {
  153. 153 "description":"地区",
  154. 154 "paramType":"body",
  155. 155 "required":false,
  156. 156 "allowMultiple":false,
  157. 157 "dataType":"region",
  158. 158 "defaultValue":"香港某条街"
  159. 159 },
  160. 160 {
  161. 161 "description":"邮箱",
  162. 162 "paramType":"body",
  163. 163 "required":false,
  164. 164 "allowMultiple":false,
  165. 165 "dataType":"email",
  166. 166 "defaultValue":"6969888@qq.com"
  167. 167 },
  168. 168 {
  169. 169 "description":"QQ号",
  170. 170 "paramType":"body",
  171. 171 "required":false,
  172. 172 "allowMultiple":false,
  173. 173 "dataType":"qq_account",
  174. 174 "defaultValue":"6969888"
  175. 175 },
  176. 176 {
  177. 177 "description":"微信号",
  178. 178 "paramType":"body",
  179. 179 "required":false,
  180. 180 "allowMultiple":false,
  181. 181 "dataType":"wx_account",
  182. 182 "defaultValue":"DLJ_6969888"
  183. 183 }
  184. 184
  185. 185 ]
  186. 186 }
  187. 187 ]
  188. 188 }
  189. 189
  190. 190
  191. 191
  192. 192 ]
  193. 193 }

 

参数apis下面一组数据,就对应一个接口,对应的重要参数如下:

path:接口名,

updateTime:更新时间,

httpMethod:请求方式,

summary:接口功能解释,

nickname:接口别名(同一个模块不可以重名),

fieldDesc:接口返回的数据,一行数据表示一个字段,举例:"result@string":"请求返回的状态1成功0失败",表示返回字段result 数据类型是string,字段说明是‘请求返回的状态1成功0失败’;

parameters:请求接口所需要的参数,一组数据表示一个参数,

description:字段说明,
required:字段是否必填,true是必填参数,false是选填参数
dataType:字段名称,
defaultValue:参数的默认值,

大功告成:访问index.html文件;

请求一下接口:

 

希望对您有帮助,谢谢!

 

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号