接口文档的编写

接口文档

背景介绍

API(Application Programming Interface)即应用程序接口。可以认为 API 是一个软件组件或是一个 Web 服务与外界进行的交互的接口。

目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。

这里接口就是后端写的方法。

比如

**substring()**方法是做裁剪的,里面两个数值(start,end)--裁剪开始,结束。最后返回裁剪好的。

接口文档

双方约定的手册,后端按照规定来,前端调用这个方法知道需要传什么参数。

给一个类似这种文档,后端不需要等待,按照这个规则去写,前端按照这个规则去用。


word书写接口文档

  1. 注明哪一模块,这里以登录模块为例。

  2. 实现的功能,比如 注册功能。(以下均以注册为例)

  3. 作用: 用于用户注册

  4. 请求路径:RegisterServlet

请求方式:post/get 这里是post

传输的数据类型:json

请求的入参:

account(账号) 类型:字符串 必传

password(密码) 类型:字符串 必传

  1. 数据样本:

{

"account":"admin",

"password":"123456"

}

  1. 响应的出参:

code(状态) 类型: 整数 必有 code如果是1表示注册成功,code如果是0表示注册失败。

message(信息) 类型:字符串 必有

  1. 注册成功数据样本:

{

"code":1.

"message":"注册成功"

}

8.注册失败数据样本:

{

"code":0.

"message":"注册失败"

}

相关推荐
RestCloud4 小时前
SaaS 系统越来越多,为什么需要一个 iPaaS 来统一管理?
api·saas
软件测试小仙女13 小时前
Pytest参数化实战:高效测试API接口
软件测试·测试开发·测试工具·pytest·接口测试·api·参数化
RestCloud1 天前
iPaaS驱动下的API管理新趋势
api
RestCloud1 天前
如何通过API网关保障企业的数据安全
api
RestCloud3 天前
一文讲清楚如何提升企业API管理能力
api
RestCloud3 天前
深入剖析iPaaS与API网关的融合应用
api
RestCloud4 天前
ETLCloud-重塑制造业数据处理新范式
api
RestCloud5 天前
制造业中的多系统困境,如何通过iPaaS“破解”
api
RestCloud5 天前
iPaaS落地实战:从规划到上线只需四步
api
万邦科技Lafite8 天前
如何对接API接口?需要用到哪些软件工具?
java·前端·python·api·开放api·电商开放平台