基于目前的大前端时代，对于常年负责后台开发的我来说， 最重要的就是提供稳定的接口和文档。便于小伙伴们进行业务对接。当下常用的是RestFul风格的定义规范， 之前开发是清一色Get、Post。引入RestFul后感觉接口定义规范很多，看接口地址就知晓是什么功能， 一起来看看列的一些基础规范吧。一、协议API与客户端用户的通信协议，总是使用HTTPS协议，以确 …
前端接口文档
我们在开发 webapi 项目时如果遇到 api 接口需要同时支持多个版本的时候，比如接口修改了入参之后但是又希望支持老版本的前端（这里的前端可能是网页，可能是app,小程序 等等）进行调用，这种情况常见于 app，毕竟网页前端我们可以主动控制发布，只要统一发布后所有人的浏览器下一次访问网页时都会重新加载到最新版的代码，但是像 app 则无法保证用户一定会第 …
一、文档里的幽灵参数：为什么前端永远传不对枚举值？“你们的接口文档在骗人！”前端组的Emily在晨会上甩出一张截图——Swagger页面上明明白白写着apiorders接口支持status=PENDING，但实际传参时却总是返回400: Invalid status value。后端团队排查后发现：所有用枚举类型接收的接口参数，只要通过Swagger文档测试 …
接口文档怎么看？其实公司大多数用的都是内部接口，第三方接口其实相比起来用得少，两者区别只是提供方不一样。接口文档其实就是一个讲解某个接口是做什么的文件。不管是你们公司内部的开发，或者是你跟一些第三方合作的时候，产品经理必须要知道怎么看接口文档，知道里面哪些部分是重要的才行。否则别说功能实现，沟通都很难进行……懂点基础知识好沟通比方说，你们公司要做一个考勤系统 …
- 1