找回密码
 立即注册
搜索

本文来自

iOS开发交流区

iOS开发交流区

人已关注

请添加对本版块的简短描述

你们公司是由谁定义接口,写接口文档的?app端还是后端?

[复制链接]

1

主题

2

帖子

27

积分

新手上路

Rank: 1

积分
27
QQ
8620 wwjwzj 发表于 2018-9-11 13:38:53
如题,公司领导要求写接口文档。之前没写过,该怎么写呢?
另外你们公司是由谁定义接口,写接口文档的?app端还是后端?




上一篇:tablview点击push到下一个页面,pop出来时,有个下拉的动作
下一篇:加载视频问题iOS
楼主热帖
beast 发表于 2018-9-11 14:53:40
如题,公司领导要求写接口文档。之前没写过,该怎么写呢?
另外你们公司是由谁定义接口,写接口文档的?app端还是后端?
回复

使用道具 举报

beautiful_night 发表于 2018-9-11 15:05:57
肯定是后端啊,谁写接口谁做文档么。
回复

使用道具 举报

issac-lam 发表于 2018-9-11 15:10:02
对的,一般应该都是后台做接口写文档。现在领导要求和后台一起弄文档,这个怎么整呀。。。 之前都是拿着后台给的现成文档写页面的。。。
回复

使用道具 举报

yyuan 发表于 2018-9-11 15:28:45
emmm。。我曾经负责写接口文档。

就是说我根据页面来决定如何获取数据,获取数据的格式等等。

接口路径、请求参数、请求方式、请求格式、返回的数据内容和格式都是我来定。

后台只负责按我写的文档进行实现就行。


补充点我的理解吧。


首先要对你自己的app所有界面有一定了解。这样才能设计出合理的接口。


根据实际需求考虑接口的聚合或拆分。比如:搜索功能。如果有多个地方用到不同种类的搜索。那么做成一个个搜索接口比较合理;反之如果只有一个页面有搜索,不同的搜索选项比较集中。那么可以做成一个搜索接口,根据不同选项传不同的参数即可。


根据返回内容消耗的时间或性能考虑。如果接口返回时间过长且无法优化的话,就要考虑进行拆分或者精简返回。


最重要的一点,一定要为以后迭代埋下伏笔。需求总是会变的。。。
[ 此帖被ad0ma在2018-04-26 16:37重新编辑 ]
回复

使用道具 举报

乱来 发表于 2018-9-11 17:09:23
谁闲谁写

本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有帐号?立即注册

x
回复

使用道具 举报

kingsley 发表于 2018-9-11 17:18:28
谢谢

本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有帐号?立即注册

x
回复

使用道具 举报

12345mylove 发表于 2018-9-11 17:20:21
的确..经常被抓取写
回复

使用道具 举报

343705365 发表于 2018-9-11 17:52:12
一起弄就行啊,你要什么数据,要怎么样格式的数据,自己定义好了,到时候开发也方便,不然后台如果写的不好,用起来都不好用。
回复

使用道具 举报

tiankongphil 发表于 2018-9-11 18:01:49
虽然说前端后端都需要考量。但是主要还是后端吧,毕竟数据都在他们那,我们需要的是要什么格式的。什么字段的内容。剩下的怎么处理是后端来的吧。
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则