设计一个高质量的API接口】的更多相关文章

参考网址:http://url.cn/5UaTeyv 前言 在设计接口时,有很多因素要考虑,如接口的业务定位,接口的安全性,接口的可扩展性.接口的稳定性.接口的跨域性.接口的协议规则.接口的路径规则.接口单一原则.接口过滤和接口组合等诸多因素,本篇文章将简要分析这些因素. 一.规范性建议 1.职责原则 在设计接口时,必须明确接口的职责,即接口类型,接口应解决什么业务问题等. 2.单一性原则 在明确接口职责的条件下,尽量做到接口单一,即一个接口只做一件事,而非两件以上.很多非资深接口设计者,在设计…
有的人觉得logo只是一个简单的图形,对品牌影响无关紧要:但有的人却觉得logo对品牌有较大的影响.其实logo承载着一个公司的品牌形象.公司背景.公司理念等.就像Landor往往给一个企业做logo要收取上百万的费用,就是因为品牌形象针对的时品牌本身,从形式.寓意.色彩甚至营销都有很深远的影响.当然对于像小餐厅的logo来说,只要设计出好看的图形,容易辨识就可以了. ​ 设计一个高质量的logo要从哪方面入手呢?1.往往客户提供的信息比较有限,设计师要通过大量的调研和信息收集去找到大的方向,找…
在日常开发中,总会接触到各种接口.前后端数据传输接口,第三方业务平台接口.一个平台的前后端数据传输接口一般都会在内网环境下通信,而且会使用安全框架,所以安全性可以得到很好的保护.这篇文章重点讨论一下提供给第三方平台的业务接口应当如何设计?我们应该考虑哪些问题? 主要从以上三个方面来设计一个安全的API接口. 一 安全性问题 安全性问题是一个接口必须要保证的规范.如果接口保证不了安全性,那么你的接口相当于直接暴露在公网环境中任人蹂躏. 1.1 调用接口的先决条件-token 获取token一般会涉…
1.背景 1.1 什么是API网关 API网关可以看做系统与外界联通的入口,我们可以在网关进行处理一些非业务逻辑的逻辑,比如权限验证,监控,缓存,请求路由等等. 1.2 为什么需要API网关 RPC协议转成HTTP. 由于在内部开发中我们都是以RPC协议(thrift or dubbo)去做开发,暴露给内部服务,当外部服务需要使用这个接口的时候往往需要将RPC协议转换成HTTP协议. 请求路由 在我们的系统中由于同一个接口新老两套系统都在使用,我们需要根据请求上下文将请求路由到对应的接口. 统一…
接上篇 HTTP-API-DESIGN 怎样设计一个合理的 HTTP API (一) 整个 ppt 可以去这里下载. 这一篇主要从服务端应该如何返回合理的返回值的角度,讨论如何设计一个合理的 HTTP-API: 主要有以下几个方面: 为每个资源,分配一个 Resource ID(UUID) 使用统一的时间戳 正确地使用外键 将错误响应信息标准化 对客户端进行流量控制 将发返回的 JSON “最小化” 为每个资源,分配一个 Resource ID(UUID) 返回的结果中,需要为每一个“资源”(用…
前言 如今nodejs变得越来越火热,采用nodejs实现前后端分离架构已被多数大公司所采用. 在过去,使用nodejs大家首先想到的是TJ大神写的express.js,而发展到如今,更轻量,性能更好的koa已然成为主流, 它同样出自TJ大神手笔,如今版本已更新到了koa2,不仅性能优异,它还支持async/await,堪称回调地狱的终结者 下面,我们来探讨下,如何使用koa2+es6/7来打造高质量的Restful风格API. 刨根问底,篇幅略长,精华在后面,需要耐心看. 1. 两种模式 一种…
Authentication,Authorization 如果公司交给你一个任务让你写一个api接口,那么我们应该如何设计这个api接口来保证这个接口是对外看起来"高大上","羡慕崇拜",并且使用起来和普通api接口无感,并且可以完美接入aspnetcore的认证授权体系呢,而不是自定义签名来进行自定义过滤器实现呢(虽然也可以但是并不是最完美的),如何让小白羡慕一眼就知道你是老鸟. 接下来我将给大家分享你不知道的自定义认证授体系. 我相信这可能是你面对aspnetc…
[起] 今早,一个技术群里有人想快速做出一个app,然后询问技术方案,大概是这样, 拿到了200w投资,期望花20w两个月先做出一个app,包括iOS,Android, 先,呵呵,一下, 大概预估了一下,两个月20w,一个月10w,基本就是一个高级ios,一个高级android,一个高级后台,基本不靠谱. [问题] 经常有人问,做一个类似xx的app需要多久多少钱,这样的问题, 这样问还算比较靠谱,如果是"我有一个想法,就差一个程序员~",那就呵呵了. 结合上面的问题,如何快速搞出一个…
[起] 今早,一个技术群里有人想快速做出一个app,然后询问技术方案,大概是这样, 拿到了200w投资,期望花20w两个月先做出一个app,包括ios,android, 先,呵呵,一下, 大概预估了一下,两个月20w,一个月10w,基本就是一个高级ios,一个高级android,一个高级后台,基本不靠谱. [问题] 经常有人问,做一个类似xx的app需要多久多少钱,这样的问题, 这样问还算比较靠谱,如果是"我有一个想法,就差一个程序员~",那就呵呵了. 结合上面的问题,如何快速搞出一个…
引语:现在互联网那么热,你手里没几个APP都不好意思跟别人打招呼!但是,难道APP就是全能的神吗?答案是否定的,除了优雅的APP前端展示,其实核心还是服务器端.数据的保存.查询.消息的推送,无不是在服务器端完成的,默默地!那么,怎样提供一个好的服务端API接口就是一个至关重要的问题了! 也许你会说,现在APP这么泛滥,谁还不会写个服务端API接口程序啊?是的,也许,你是对的,但是本文想说明的和要讲的故事,是一个从零到一故事,是一个思想,是一个历程,一个可以推演的过程! 在给出答案之前,先抛几个问…