接口文档模板

╰+攻爆jí腚メ 2022-05-24 09:11 385阅读 0赞

**获取用户信息**

开发者通过指定页数、每页显示条数，获取用户信息。

接口调用请求说明  
http请求方式: GET  
http://127.0.0.1:8080/CrazyDormitory-Server/stu/userList.json?p=1&num=5

参数说明

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:top;"> <p><strong><span style="color:#333333;">参数</span></strong></p> </td> 
   <td style="vertical-align:top;"> <p><strong><span style="color:#333333;">是否必须</span></strong></p> </td> 
   <td style="vertical-align:top;"> <p><strong><span style="color:#333333;">说明</span></strong></p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p><span style="color:#333333;">p</span></p> </td> 
   <td style="vertical-align:top;"> <p><span style="color:#333333;">是</span></p> </td> 
   <td style="vertical-align:top;"> <p><span style="color:#333333;">指定页数</span></p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p><span style="color:#333333;">n</span><span style="color:#333333;">um</span></p> </td> 
   <td style="vertical-align:top;"> <p><span style="color:#333333;">是</span></p> </td> 
   <td style="vertical-align:top;"> <p><span style="color:#333333;">每页要显示的数量</span></p> </td> 
  </tr> 
 </tbody> 
</table>

返回说明

正常情况下，后台会返回下述格式JSON数据包：

\{

"datas":\[

\{

"dormitory":"5栋",

"id":12,

"name":"彭珂",

"phone":"15166668888",

"school":"江西xxx大学",

"sex":"男"

\}

\]

\}

参数说明

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:top;"> <p><strong><span style="color:#333333;">参数</span></strong></p> </td> 
   <td style="vertical-align:top;"> <p><strong><span style="color:#333333;">说明</span></strong></p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p>dormitory</p> </td> 
   <td style="vertical-align:top;"> <p><span style="color:#333333;">宿舍</span></p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p><span style="color:#333333;">id</span></p> </td> 
   <td style="vertical-align:top;"> <p><span style="color:#333333;">I</span><span style="color:#333333;">d</span></p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p>name</p> </td> 
   <td style="vertical-align:top;"> <p><span style="color:#333333;">姓名</span></p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p>&nbsp;</p> </td> 
   <td style="vertical-align:top;"> <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p>Phone</p> </td> 
   <td style="vertical-align:top;"> <p><span style="color:#333333;">联系方式</span></p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p>School</p> </td> 
   <td style="vertical-align:top;"> <p><span style="color:#333333;">学校</span></p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p>Sex</p> </td> 
   <td style="vertical-align:top;"> <p><span style="color:#333333;">性别</span></p> </td> 
  </tr> 
 </tbody> 
</table>

没有查询到:

\{"datas":\[\]\}

>>>---------------------------------------------------<<<

## **[学习资料下载][Link 1]** ##

>>>---------------------------------------------------<<<

[Link 1]: https://www.vipkes.cn

发表评论取消回复

表情：

评论列表（有 0 条评论，385人围观）

还没有评论，来说两句吧...

相关阅读

相关文档的重要性及接口文档模板

随着工作年限的增长，我们逐渐意识到工作中文档的重要性不可忽视。优质的文档不仅能提高工作效率，还能有效降低沟通成本，因此我们必须注重文档的撰写和格式。最近，由于未能及时更新文档，

青旅半醒/ 2024年02月21日 10:47/ 0 赞/ 57 阅读

相关接口测试文档

个人项目 > v1.0.0 Base URLs: [本地测试: http://localhost:8081/ssm][http_localhost_8081_s

Love The Way You Lie/ 2023年10月14日 08:32/ 0 赞/ 43 阅读

相关 Macdown接口文档模板

样式： ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0F

Bertha 。/ 2023年06月23日 03:57/ 0 赞/ 26 阅读

相关需求文档模板

> 如果经历了好的产品文档和不好的产品，开发就能体会到一个好的产品的珍贵，而需求文档则是一个产品能力的有效体现，最近看到了一个非常好的产品文档的模板，原文是用confluen

蔚落/ 2023年01月18日 02:29/ 0 赞/ 232 阅读

相关详细设计文档模板

原文地址：[https://www.cnblogs.com/hellowzl/p/11511922.html][https_www.cnblogs.com_hellowzl_

绝地灬酷狼/ 2023年01月12日 14:58/ 0 赞/ 180 阅读

相关 showdoc + runapi —— 接口文档模板生成管理和接口调试工具

showdoc + runapi ShowDoc 工具介绍使用指南注册项目文档操作

谁借莪１个温暖的怀抱￠/ 2022年12月20日 12:57/ 0 赞/ 613 阅读

相关生成接口文档

Swagger生成接口文档，no no no JApiDocs是一个无需额外注解、开箱即用的SpringBoot接口文档生成工具。编写和维护API文档这个事情，对于后端程

比眉伴天荒/ 2022年12月04日 09:17/ 0 赞/ 377 阅读

相关接口文档笔记

文章目录版本变更记录接口列表接口1 接口编号+接口名称请求

朱雀/ 2022年10月22日 06:26/ 0 赞/ 356 阅读

相关接口文档模板

获取用户信息开发者通过指定页数、每页显示条数，获取用户信息。接口调用请求说明 http请求方式: GET http://127.0.0.1:8080/Crazy

╰+攻爆jí腚メ/ 2022年05月24日 09:11/ 0 赞/ 386 阅读

相关 laravel接口接口文档

接口先在控制器里写一个接口的方法之所以写了两个方法因为写接口单独创建一个控制器比较好避免与页面展示冲突 // 展示页面配合城市接口执行 pu

太过爱你忘了你带给我的痛/ 2022年04月17日 01:59/ 0 赞/ 645 阅读