接口文档的设计问题

Question

接口的设计问题：

1. 一个接口的定义、以及接口实现的逻辑，如何使用文档的方式，给到开发人员。
2. 比如说，设计一个登陆接口，这个接口要验证那些内容、实现逻辑是怎么样的，以文档的形式描述给开发人员

因为，我不能靠口头描述给开发人员，以及更换开发人员以后，如果没有相关文档，以后就没有人知道这个接口，为什么是这样的逻辑。

Answer 1

geelylucky 2020-11-03 22:35:19

同学，这是软件工程的基础知识。按照开发流程来说，软件开发人员需要有对应的接口设计文档才能进行下一步的代码编写，接口设计里面需要写清楚输入输出以及其他注意事项。这样也方便今后的工作交接和业务理解。

• 提问者 慕粉4194439 #1

  如果我想学习这一块的知识，应该如何入手，有没有学习推荐，或是相关文档的模板？