接口怎么写(接口文档一般由谁写)

界面呢？事实上，大多数公司使用内部接口，而第三方接口实际上使用较少。两者的区别在于提供者不同。

接口实际上是一个解释接口做什么的文件。无论是你公司内部开发，还是你和一些第三方合作的时候，产品经理都必须知道如何阅读接口文档，以及哪些部分是重要的。

否则，不要谈功能实现，沟通会很困难...

了解一些基础知识，善于沟通。

比如你们公司想做一个考勤系统，想用人脸识别打卡，但是人脸识别可能技术上有点难度，所以我们决定用第三方。

找第三方，第三方可能会扔给你一个界面文档给自己看。

这个时候你要知道这个界面提供了什么功能，需要用什么，你的界面能满足什么思想，不能满足什么思想。

比如有一种情况，人们经常戴口罩或者墨镜。在这个api接口提供的人脸识别打卡功能中，如果一个人戴上眼睛后还能打卡，就需要在他的文档中找到，看他是否具备相应的能力。

R&D还涉及到写很多东西~比如接口文档。

我来介绍一些概念:

请求参数

比如你需要让阿里云给你发短信，你至少要告诉他你想发给哪个手机吧？这个手机号码是请求参数。在请求接口的时候，你需要把这个请求参数给他。

请求与设计功能有关，所以在产品设计时需要考虑如何请求这些参数。在检查接口文档时，注意是否所有的请求参数都已写入也很重要。

与请求参数相对应的是返回参数。

请求完成后，它会告诉你是否发送成功。如果成功，则返回查询的信息，如果失败，则报错。比如你查询一个订单或者一个产品页面的详细信息，界面需要把产品查到的产品的关键信息返回给你。这是返回参数。一般工作中会有很多“回归参数”。

一般会返回多个字段，但是我们需要知道它的字段在接口文档中是什么意思，比如参数名是什么，类型是什么；如果有错误，它会给你一些错误代码。比如你下一笔支付订单，前端调用时返回错误403，然后你看这个时候的接口文档就知道403是什么意思了。

界面可以是word，txt等。形式并不重要，但关键是需要很好地理解文档中最关键的七个步骤:

1.接口描述:简要描述接口的功能。

2.接口地址是什么？

如果接口被公开给其他人使用，它必须有一个地址。一定要知道请求的地址是什么，也就是请求的网址是什么。

3.调用时的方法类型是什么？

本文将介绍Pose或get。

post和get有什么区别？传输get请求时，URL的后面会附上URL地址，也就是说URL上会有请求参数，get请求的参数长度有限；post请求的参数不会显示在URL中。

四