如何正确规范写接口文档 以你之姓@ 2022-05-29 02:54 151阅读 0赞 ## 前言 ## 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。下面我将我看到的一篇接口文档做一个总结 ## 开始吧!!! ## ### 接口1: 查询排重接口 ### <table> <thead> <tr> <th>接口详情</th> <th></th> </tr> </thead> <tbody> <tr> <td>地址</td> <td><a href="http://www.baidu.com" rel="nofollow">http://www.baidu.com</a> (正式环境)</td> </tr> <tr> <td>请求方式</td> <td>GET</td> </tr> </tbody> </table> <table> <thead> <tr> <th>参数</th> <th>是否必填</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>idfa</td> <td>是</td> <td>广告标识符,只支持单个查询</td> </tr> <tr> <td>source</td> <td>是</td> <td>渠道来源,具体值在接入时再进行分配</td> </tr> </tbody> </table> -------------------- <table> <thead> <tr> <th>返回结果</th> <th>格式</th> <th>JSON</th> </tr> </thead> <tbody> <tr> <td>状态码</td> <td>10000</td> <td>success(调用成功)</td> </tr> <tr> <td></td> <td>10001</td> <td>param error(参数错误)</td> </tr> <tr> <td></td> <td>10002</td> <td>query failed(查询失败)</td> </tr> <tr> <td></td> <td>10010</td> <td>access prohibited(访问拒绝)</td> </tr> </tbody> </table> -------------------- 具体返回结果举例: 1、查询成功 { "state": 10000, "message": "success", "data": { "BD239708-2874-417C-8292-7E335A537FAD": 1 //已经存在 } } { "state": 10000, "message": "success", "data": { "BD239708-2874-417C-8292-7E335A537FAD": 0 //不存在 } } 1. 接口调用失败 { "state": 10010, "message": "access prohibited", "data": [ ] } 如果满意,请打赏博主任意金额,感兴趣的请下方留言吧。可与博主自由讨论哦 <table> <thead> <tr> <th align="center">支付包</th> <th align="center">微信</th> <th align="center">微信公众号</th> </tr> </thead> <tbody> <tr> <td align="center"><img src="https://raw.githubusercontent.com/HealerJean123/HealerJean123.github.io/master/assets/img/tctip/alpay.jpg" alt="支付宝" title=""></td> <td align="center"><img src="https://raw.githubusercontent.com/HealerJean123/HealerJean123.github.io/master/assets/img/tctip/weixin.jpg" alt="微信" title=""></td> <td align="center"><img src="https://raw.githubusercontent.com/HealerJean123/HealerJean123.github.io/master/assets/img/my/qrcode_for_gh_a23c07a2da9e_258.jpg" alt="微信公众号" title=""></td> </tr> </tbody> </table>
相关 Java代码规范:如何正确书写对象初始化语句? 在Java中,对象的初始化通常通过构造函数来完成。以下是正确书写对象初始化语句的一般步骤: 1. 创建类:首先需要定义一个类,这个类将包含你想要创建的对象。 ```java ﹏ヽ暗。殇╰゛Y/ 2024年09月11日 12:51/ 0 赞/ 11 阅读
相关 接口文档编写规范(前后端分离项目接口api) 接口文档编写规范 API规范 > api 主要包括四部分:uri、请求方式、请求参数、返回参数,一般就是对这四部分做统一规范 接口url:是否是rest风格的, 迈不过友情╰/ 2024年04月06日 12:19/ 0 赞/ 32 阅读
相关 怎样写好接口文档_高效实用的接口文档编写技巧 接口文档是什么,怎样写好接口文档 接口文档是一个软件系统的重要组成部分,它描述了系统中所有可供外部应用程序使用的接口。简单来说,接口文档就是用来帮助开发者开发和对接系统的 「爱情、让人受尽委屈。」/ 2023年10月12日 22:15/ 0 赞/ 10 阅读
相关 先写接口文档还是先开发 文章目录 先写接口文档是正确的 为什么有的人喜欢先写开发 什么情况可以先开发 之前都是个人维护一个项 怼烎@/ 2022年11月15日 11:47/ 0 赞/ 138 阅读
相关 如何正确使用数据库读写分离 背景 在应用系统发展的初期,我们并不知道以后会发展成什么样的规模,所以一开始不会考虑复杂的系统架构,复杂的系统架构费时费力,开发周期长,与系统发展初期这样的一个定位是不吻 野性酷女/ 2022年10月17日 10:49/ 0 赞/ 128 阅读
相关 如何正确规范写接口文档 前言 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。下面我将我看到的一篇接口文档做一个总结 开 以你之姓@/ 2022年05月29日 02:54/ 0 赞/ 152 阅读
相关 C++:如何正确的使用接口类 前一篇文章中讲过C++中如何正确的定义接口类,那定义好的接口类如何正确使用?本篇将细细说说。 提供接口与实现 首先,声明一个接口: // circle.h 深碍√TFBOYSˉ_/ 2022年05月21日 06:59/ 0 赞/ 137 阅读
相关 如何正确实现IDisposable接口 如果一个对象拥有非托管资源,则应该实现IDisposable接口,这样调用方可以在使用之后及时释放资源。 有很多关于.Net的书籍和文章都描述了如何实现IDisposabl 男娘i/ 2021年12月01日 11:42/ 0 赞/ 220 阅读
相关 如何写一份接口需求文档? 在产品设计工作中,或多或少都会需要用到接口,特别是业务导向性的系统,接口几乎是必不可少的功能。那么什么是接口?如何写一份能准确表达业务需求的接口需求文档呢? 一、什么是... 小鱼儿/ 2021年05月02日 13:25/ 0 赞/ 464 阅读
还没有评论,来说两句吧...