API接口设计规范 - 相关文章

【API接口设计规范】的更多相关文章

API 接口设计规范

概述这篇文章分享 API 接口设计规范,目的是提供给研发人员做参考. 规范是死的,人是活的,希望自己定的规范,不要被打脸. 路由命名规范动作前缀备注获取 get get{XXX} 获取 get get{XXX}List 新增 add add{XXX} 修改 update update{XXX} 保存 save save{XXX} 删除 delete delete{XXX} 上传 upload upload{XXX} 发送 send send{XXX} 请求方式请求方式描述 GET…

restFull api接口

RestFull api接口前后端分离开发的接口规范什么是RestFull 是目录比较流行的api设计规范注:restfull api规范应用场景,前后端分离的项目中数据接口的现场例如: /users/999 获取ID为999的信息 /users/list 获取所有的用户信息 /users/add 打开添加的页面 /users/save 新增数据 /users/edit 打开修改的页面 /users/save 根据表单是否有主键的值判断是否有更新 /users/del/999 删…

如何设计一个牛逼的API接口

在日常开发中,总会接触到各种接口.前后端数据传输接口,第三方业务平台接口.一个平台的前后端数据传输接口一般都会在内网环境下通信,而且会使用安全框架,所以安全性可以得到很好的保护.这篇文章重点讨论一下提供给第三方平台的业务接口应当如何设计?我们应该考虑哪些问题? 主要从以上三个方面来设计一个安全的API接口. 一安全性问题安全性问题是一个接口必须要保证的规范.如果接口保证不了安全性,那么你的接口相当于直接暴露在公网环境中任人蹂躏. 1.1 调用接口的先决条件-token 获取token一般会涉…

干货来袭-整套完整安全的API接口解决方案

在各种手机APP泛滥的现在,背后都有同样泛滥的API接口在支撑,其中鱼龙混杂,直接裸奔的WEB API大量存在,安全性令人堪优在以前WEB API概念没有很普及的时候,都采用自已定义的接口和结构,对于公开访问的接口,专业点的都会做下安全验证,数据签名之类反而现在,谁都可以用WEB API估接口,安全性早忘一边了,特别是外包小公司的APP项目,80%都有安全漏洞(面试了大半年APP开发得出的结论) 特在过年之前,整理了下在用的解决方案,本方案解决了数据安全问题标准消息结构接口测试程序接…

12306官方火车票Api接口

2017,现在已进入春运期间,真的是一票难求,深有体会.各种购票抢票软件应运而生,也有购买加速包提高抢票几率,可以理解为变相的黄牛.对于技术人员,虽然写一个抢票软件还是比较难的,但是还是简单看看12306相关的接口,如果有类似的需求或业务,或者此文章可以帮助到你. 背景在一些需要工具等应用可能会应用到火车票信息的查询,但是又不知去哪里找即免费又不限制次数的Api接口,呵呵,今天我简单给你介绍一些Api接口的抓取,不要激动,最终还是希望可以帮助到你.对于有web开发经验的,可直接忽略此文,本文仅…

快递Api接口 & 微信公众号开发流程

之前的文章,已经分析过快递Api接口可能被使用的需求及场景:今天呢,简单给大家介绍一下微信公众号中怎么来使用快递Api接口,来完成我们的需求和业务场景. 开发语言:Nodejs,其中用到了Neo4j图形数据库准备工作首先,需要到微信公众平台注册账号选择账号类型界面如下: 选择订阅号或服务器都可以,本文是使用订阅号进行展开描述.开发微信小程序的选择小程序即可,不过暂时不对个人开发,只能呵呵了. 选择之后,根据注册流程,一步步填写验证即可. 注册完成后,到微信公众平台登陆即可. 登陆成功,如下…

web api接口同步和异步的问题

一般来说,如果一个api 接口带上Task和 async 一般就算得上是异步api接口了. 如果我想使用异步api接口,一般的动机是我在我的方法里面可能使用Task.Run 进行异步的去处理一个耗时的操作. Q1.如果一个api接口很耗时,比如需要10s,会影响我的前端展示吗? --不会.很多js可以异步请求api接口,当接口返回数据时,通过回调方法,显示数据. Q2.对于存在耗时的api接口,使用异步api接口(接口内部可能使用 Task.Run 异步操作)一定可以提高响应吗? --不一定.举…

【API接口设计规范】的更多相关文章