[日常] 编写HTTP接口文档
程序员文章站
2022-03-18 14:49:20
一、什么是接口文档?在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。二、为什么要写接口文档?1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发2、项目维护中或者项目人员更迭, ......
一、什么是接口文档?
在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。
二、为什么要写接口文档?
1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发
2、项目维护中或者项目人员更迭,方便后期人员查看、维护
RESTful 接口:
REST 是一个很流行的前后端交互形式的约定。这只是一套约定,并不是某个技术标准.REST 充分利用了 HTTP 规范中的方法,达到接口描述的语义化
安全:
1.使用HTTPS协议
2.数据加密
权限处理:
1.客户端接口,携带验证token
2.WEB端接口,使用SESSION验证机制
上一篇: javascript 事件基础
下一篇: DAY1-初识python