接口文档的编写

接口文档

背景介绍

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":"注册失败"

}

相关推荐
遥感学习森1 天前
道路提取与道路变化检测算法:技术特性与应用价值解析
api·智能解译提取·解译提取算法·道路提取
RestCloud1 天前
ETLCloud数据集成平台:破解制造业数据困局的智能引擎
api
RestCloud1 天前
一文读懂数据湖、数据仓库与ETL的关系
api
RestCloud2 天前
IDC最新报告:谷云科技iPaaS订阅市场稳居独立厂商第一,市场份额全国第二,仅次于华为!
api
刘欣的博客2 天前
C# 上传票据文件 调用Dify的API完成OCR识别
c#·ocr·api·dify
蓝倾3 天前
小红书item_get接口JSON数据解析指南
api·fastapi
RestCloud4 天前
企业成本算不清,交付准不了?如何通过iPaaS处理在业务中产生的数据
api
RestCloud4 天前
IDC最新报告:谷云科技 iPaaS以34.4%的增速领先全行业
api
RestCloud5 天前
从数据孤岛到数据中台:ETL + iPaaS如何重塑企业数据架构
api
onelafite5 天前
怎么获取小红书用户笔记作品列表?item_search_shop_videoAPI接口指南
api·fastapi