项目开发流程以及接口文档

项⽬开发流程

接⼝⽂档

⼀、什么是接⼝⽂档？

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

⼆、为什么要写接⼝⽂档？

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

三、接⼝规范是什么？

⾸先接⼝分为四部分：⽅法、uri、请求参数、返回参数

⽅法
url
请求参数
返回参数

数据字典

项目开发流程以及接口文档相关推荐

【接口测试基础】第四篇 | 接口测试流程及接口文档解析
接口测试流程 1.分析需求,产生需求文档(产品) 2.开发产生接口文档,测试解析接口文档 3.测试产生测试用例(送审) 4.测试执行测试用例工具:postman,jmeter 代码:python+R ...
014-Axios Ajax：前后端分离概述，发送json类型的参数，前后端分离开发：在线接口文档，前端工程化、Element、nginx
第一节 Ajax概述 1.概述概念: Asynchronous JavaScript And XML,异步的JavaScript和XML. 作用: 数据交换:通过Ajax可以给服务器发送请求,并获取 ...
接口测试实战项目02：根据接口文档测试
大家好,我是测试奇谭的作者风风. 上两次,我们已经了解: 测试奇谭:什么是接口测试?这篇文章让你明白测试奇谭:接口测试实战项目01:接口测试环境搭建这次,我们正式进入测试阶段. 为什么要做接口测试 ...
微信小程序开发指南，接口文档，工具下载使用
相信前天,从事互联网行业人的朋友圈给刷爆了,前微信公众平台开始陆续对外发送小程序内测邀请,而小程序即被外界广为关注的微信"应用号". 小程序的推出也并非一蹴而就,早在2016年1月 ...
教育平台项目后台管理系统：接口文档
课程管理模块接口文档课程信息模块接口接口 1:查询课程列表信息名称: findCourseList 描述: 查询课程列表信息 URL: http://localhost:8080/lagou_e ...
项目开发中发布更新文档备注
项目开发中经常会遇到某一个团队成员更新了,配置文件但是没有及时沟通导致项目发布后出现异常的情况. 这时就需要一个项目更新发布的规范说明文件,比如每次更新更改了哪些,进行文档备注. 更新的脚本文件也 ...
开发必备工具，快速生成接口文档、调用示例、mock配置
前言开发中,接口文档很重要,特别是现在web开发都开始前后端分离了,更加需要一个好的接口文档. 那要怎么快速的出接口文档.调用示例.mock呢?如果太麻烦,很多人就不愿意去写了. 今天给大家介绍一个 ...
芋道 Spring Boot API 接口文档 Swagger 入门
点击上方"芋道源码",选择"设为星标" 做积极的人,而不是积极废人! 源码精品专栏原创 | Java 2020 超神之路,很肝~ 中文详细注释的开源项目 RP ...
sentinel 官方文档_SpringCloud网关聚合Swagger接口文档实践
目前大多数项目都是以微服务架构设计,以前后端分离技术解耦前端开发工程师和后端开发工程师的工作量,这样一来前后端的对接将是一项重要的沟通工作量,如果后端没有一个合适的API文档,那么这样的前后端对接将是 ...
Java—使用ApiDoc接口文档
Java-使用ApiDoc接口文档前言介绍: 之前写过使用Swagger编写Api接口文档 ,介绍了Java怎么使用Swagger做项目的Api接口文档.也百度过现在生成Api接口文档的工具,看到 ...

项目开发流程以及接口文档

项⽬开发流程

接⼝⽂档

⼀、什么是接⼝⽂档？

⼆、为什么要写接⼝⽂档？

三、接⼝规范是什么？

数据字典

项目开发流程以及接口文档相关推荐

最新文章

热门文章