提供给别人接口需要注意什么

本文档强调了接口设计的重要细节,包括参数类型列举、枚举值解释、接口功能描述及参数规则说明。建议提供所有可能的类型列表,详细解释简写字符串或数字含义,明确接口是用于数据获取还是保存。同时,接口结果也需要详细说明参数意义,确保文档清晰全面,便于开发者使用。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1、接口参数

A 接口参数中,如果有表示类型的参数,需要将这个接口所有的这个类型提供全部的列表,不然用这个接口的人不知道有哪一些类型。

B 接口参数中,如果有用简单字符串或者数字代表某个意义,一定要讲这个简单字符串或者数字代表的意义详细说明。

2、接口表述

A 接口的作用是什么,用来获取数据么、用来写入保存数据么

B 接口参数的规则需要详细写清楚

C 接口结果如果需要,也要详细说明参数意义,如果也有上述1、接口参数中的情况,也要按照上面写清楚,提供详细列表

总结:不要废话也不要太简单,列表多应用

仅供自己笔记

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值