项目开发流程

最新推荐文章于 2024-07-04 08:29:34 发布

原创最新推荐文章于 2024-07-04 08:29:34 发布 · 86 阅读

·

1

·

CC 4.0 BY-SA版权

版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

文章标签：

博客介绍了接口文档相关内容，包括其定义，即在项目开发中前后端工程师共同定义并维护的文档；说明了编写接口文档的原因，如方便沟通交流、便于后期维护；还提及接口规范分为方法、url、请求参数、返回参数四部分，此外还列出了数据字典。

在这里插入图片描述

接口文档

⼀、什么是接口文档？

在项⽬开发中，web项⽬的前后端分离开发，APP开发，需要由前后端⼯程师共同定义接⼝，编写接⼝
⽂档，之后⼤家都根据这个接⼝⽂档进⾏开发，到项⽬结束前都要⼀直维护。

⼆、为什么要写接口文档？

1、项⽬开发过程中前后端⼯程师有⼀个统⼀的⽂件进⾏沟通交流开发
2、项⽬维护中或者项⽬⼈员更迭，⽅便后期⼈员查看、维护

三、接口规范是什么？
⾸先接口分为四部分：方法、url、请求参数、返回参数

方法
url
请求参数
返回参数

数据字典

在这里插入图片描述

评论

成就一亿技术人!

拼手气红包6.0元

还能输入1000个字符

添加红包

插入表情

表情包

代码片

HTML/XML
objective-c
Ruby
PHP
C
C++
JavaScript
Python
Java
CSS
SQL
其它

条评论被折叠查看

被折叠的条评论为什么被折叠?

到【灌水乐园】发言

查看更多评论

添加红包

成就一亿技术人!

hope_wisdom

发出的红包

实付元

使用余额支付

点击重新获取

扫码支付

钱包余额 0

抵扣说明：

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