谈 API 的撰写 - 总览】的更多相关文章

背景 之前团队主要的工作就是做一套 REST API.我接手这个工作时发现那些API写的比较业余,没有考虑几个基础的HTTP/1.1 RFC(2616,7232,5988等等)的实现,于是我花了些时间重写,然后写下了那篇文章. 站在今天的角度看,那时我做的系统也有不少问题,很多 API 之外的问题没有考虑: API 的使用文档.当时我的做法是把文档写在公司使用的协作系统 confluence 里,但这样做的最大的问题是:代码和文档分离,不好维护. API 的监控.整个 API 系统没有一个成体系…
在 谈 API 的撰写 - 总览 里我们谈到了做一个 API 系统的基本思路和一些组件的选型,今天谈谈架构. 部署 首先要考虑的架构是部署的架构.部署的方案往往会深刻影响着系统的结构.我们需要问自己一个问题:从宏观上看,这个系统我们希望如何进行部署? 很多 API 系统是这样部署的(方案一): (load balancer 和 nginx proxy (web server) 可能是同一个 cluster.这里逻辑上把他们划分开来.) 这是很典型的做法,所有的 API 在一套系统里部署,简单,高…
在做一个系统时,有一些子系统几乎是必备的:配置管理,CLI,以及测试框架. 配置管理 我们先说配置管理.一个系统的灵活度,和它的配置管理是离不开的.系统中存在的大量的预置的属性(下文简称 property),需要有一个公共的地方来放置.这里我不说「常量」,而是说「预置的属性」,是因为这属性可能需要在运行时发生改变,而常量的范畴会让人有所误解. 最简单的配置管理就是把所有的 property 放在一个配置文件中,在系统启动的时候读入.配置文件的类型有很多选择:ini,json,yaml,toml…
前面在谈微服务架构的时候,我博客上转过Chris Richardson 微服务系列中对微服务网关的描述: 通常来说,使用 API 网关是更好的解决方式.API 网关是一个服务器,也可以说是进入系统的唯一节点.这与面向对象设计模式中的 Facade 模式很像.API 网关封装内部系统的架构,并且提供 API 给各个客户端.它还可能还具备授权.监控.负载均衡.缓存.请求分片和管理.静态响应处理等功能.下图展示了一个适应当前架构的 API 网关. API 网关负责服务请求路由.组合及协议转换.客户端的…
序言 API经济生态链已经在全球范围覆盖, 绝大多数企业都已经走在数字化转型的道路上,API成为企业连接业务的核心载体, 并产生巨大的盈利空间.快速增长的API规模以及调用量,使得企业IT在架构上.模式上面临着更多的挑战.关于如何承载现有快速发展的API生态链,本文接下来介绍API网关在其中扮演的角色. API是什么 应用编程接口(Application Programming Interface,简称:API),就是软件系统不同组成部分衔接的约定[维基百科].简单的例子: 您每次登陆微信, 需…
为什么需要了解一些API设计? 只要你编程,你就是API Designer 一个好的设计,模块之间的耦合应该也是API级别的 一个程序,如果你独立开发,那你既是API的Designer,也是API的User 如果你和你的同事一起开发,,你既是你开发的模块API的Designer,也是其他同事模块API的User 一个好的API应该具备哪些特点? 1. 易学易用(Easy to learn and use) 要做到易学易用,需要满足以下基本要求: a. API命名的要适应用户的习惯并遵循一些模式.…
一.简述 安全是恒久的话题,如果不注意防范,会带来很严重的后果.比如: 1.接口被大规模调用消耗系统资源,影响系统的正常访问,甚至系统瘫痪 2.数据泄露 3.伪造(篡改)数据,制造垃圾数据 4.App被仿制- 那么我们设计API时,就要保证RESTful API的安全性,主要包括三大方面: a) 对受限资源的登录授权 b) 对请求做身份认证,并且防止篡改,重放攻击 c) 对敏感的数据做加密 二.受限资源的登录授权 此流程不是本文重点,不赘述,基本流程如下: 1. 客户端提交账号信息(用户名+密码…
Chris Richardson曾经在他的博客上详细介绍过API网关,包括API网关的背景.解决方案以及案例.对于大多数基于微服务的应用程序而言,API网关都应该是系统的入口,它会负责服务请求路由.组合及协议转换.如Chris所言,在微服务的应用程序中,客户端和微服务之间的交互,有如下几个挑战: 微服务提供的API粒度通常与客户端的需求不同,微服务一般提供细粒度的API,也就是说客户端需要与多个服务进行交互. 不同的客户端需要不同的数据,不同类型客户端的网络性能不同. 服务的划分可能会随时间而变…
小程序入门 一.准备 首先先去微信公众平台注册一个小程序账号,去拿到一个AppID(没AppID也可以开发,只是有些功能会受限),注册成功后到开发设置获取自己的AppID,即使有AppID有些功能还是不开放的,例如微信支付,小程序发布.这些功能需要通过认证之后才可(认证要交300块).开发之前还需要下载个微信web开发者工具. 微信公众平台网址: https://mp.weixin.qq.com/ 微信web开发者工具下载: https://mp.weixin.qq.com/debug/wxad…
首先了解一下他们的定义 API:application program interface 应用程序接口 通常表示一些事先定义好的函数,为了向外部提供一组功能的实现,实现和其他软件的交互 SDK:software development kit 软件开发工具包 类似于第三方服务商提供的实现产品某一部分功能的工具包 举个栗子: SDK: 比如支付宝,很多App.网站等消费者都需要使用支付这个功能/服务,但是又不想自己去开发这个东西,那么支付宝就说"你们告诉我,你们需要使用的环境是什么样的"…
原文 : http://mp.weixin.qq.com/s?__biz=MzA3NDM0ODQwMw==&mid=208060670&idx=1&sn=ce67b8896985e8448137052b338093e0 两周前因为公司一次裁人,好几个人的活都被按在了我头上,这其中的一大部分是一系列REST API,撰写者号称基本完成,我测试了一下,发现尽管从功能的角度来说,这些API实现了spec的显式要求,但是从实际使用的角度,欠缺的东西太多(各种各样的隐式需求).REST AP…
在现在大型的项目或者软件开发中,一般都会有很多种终端, PC端比如Winform.WebForm,移动端,比如各种Native客户端(iOS, Android, WP),Html5等,我们要满足以上所有这些客户端的需求,实现前后端的分离,一种最常见的做法是,编写WebService API来为以上客户端提供数据.近年来越来越多的企业或者网站支持Restfull方式的WebService,比如当当网开源Dubbox,扩展Dubbo服务框架支持REST风格远程调用,这个是Java版本的,在.NET中…
整个2015年,如果要给自己打上一个标签的话,那应该就是 API. 在各个不同的系统中定制各种 API 框架. 在做商城对接各种电商 ERP 的 API 开发中,我采用的是兼容SHOPEX 的 API 接口,因为各种 ERP 基本都支持. 在做禅道的 API 接口开发中,我对比了市面上主流 IDE 对 Issue 管理系统接口的支持情况,采用了 Redmine 的 API 兼容模式开发. 等等. 在 API 的设计中,个人最感兴趣的,应该是兼容.尽管 Oracle 赢了 Java API 的官司…
[01]浅谈HTTP在WebApi开发中的运用 [02]聊聊WebApi体系结构 [03]详解WebApi如何传递参数 [04]详解WebApi测试和PostMan [05]浅谈WebApi Cores [06]详解WebApi 异常处理 [07]用WebAPI写个基于EF的CURD [08]浅谈WebAPI身份认证 [09]详解系列化和模型绑定 [10]浅谈WebApi如何配合Mvc有效工作 [11]浅谈API Reference [12]浅谈接口在软件架构中的作用 [13]浅谈WebApi和…
WebApi系列文章 [01]浅谈HTTP在WebApi开发中的运用 [02]聊聊WebApi体系结构 [03]详解WebApi参数的传递 [04]详解WebApi测试和PostMan [05]浅谈WebApi Cores [06]详解WebApi 异常处理 [07]用WebAPI写个基于EF的CURD [08]浅谈WebAPI身份认证 [09]详解系列化和模型绑定 [10]浅谈WebApi如何配合Mvc有效工作 [11]浅谈API Reference [12]浅谈接口在软件架构中的作用 [13…
目前许多前后端应用都采取REST架构风格,前端应用和后端服务通过API进行数据交换.通过REST API在网络中进行数据交换时很容易被网络抓包,然后进行恶意批量调用,最终导致后端服务不堪负重而影响正常业务,甚至通过数据篡改制造大量垃圾数据.鉴于此,REST API的安全就变得非常重要!不考虑任何REST API安全防护的系统可能会受到如下攻击:    ▇ 重放攻击,DoS/DDoS攻击,导致系统被大量恶意请求拖垮,影响正常业务    ▇ 数据篡改,产生大量的垃圾数据    ▇ 敏感数据被泄露  …
阅读编程资料时经常会看到API这个名词,网上各种高大上的解释估计放倒了一批初学者.初学者看到下面这一段话可能就有点头痛了. API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节.——百度百科 这篇文章我们就来通俗易懂地解释下什么叫做 API,你只需要花费1分钟时间. 从文件操作开始谈API. 以C语言为例,我们使用fopen…
http://architect.dataguru.cn/article-11431-1.html API Gateway(API GW / API 网关),顾名思义,是出现在系统边界上的一个面向 API 的.串行集中式的强管控服务,这里的边界是企业 IT 系统的边界,主要起到隔离外部访问与内部系统的作用.在微服务概念的流行之前,API 网关的实体就已经诞生了,例如银行.证券等领域常见的前置机系统,它也是解决访问认证.报文转换.访问统计等问题的.   API 网关的流行,源于近几年来,移动应用与…
本文转载于https://blog.csdn.net/cumtdeyurenjie/article/details/80211896 感谢作者 仁杰兄 大家可能最近经常听到 API 这个概念,那什么是API,它又有什么特点和好处呢? wiki 百科镇楼 …[APIs are] a set of subroutine definitions, protocols, and tools for building application software. In general terms, it’s…
原文地址:http://blog.codefx.org/libraries/junit-5-setup/ 原文日期:15, Feb, 2016 译文首发:Linesh 的博客:环境搭建 我的 Github:http://github.com/linesh-simplicity 2015年11月,Junit Lambda 团队发布了该项目的 第一版原型 .此后,该项目把名称改成了 JUnit 5 并独立了出来,随后在2016年2月份的时候发布了一个 alpha 版本.本篇打算以一系列文章,简短地探…
之前的几篇翻译都烂尾了,这篇希望....能好些,恩,还有往昔呢. ------------------------------------------------------------- primitive 图元 tris  三角形 quad 栅格 ------------------------------------------------------------ 第十部分 译:minggoddess 欢迎回来.上一次,我们一头扎进了像素管线的最底端.这次,切换到管线的中间位置看一下伴随D…
越来越多的人开始意识到,网站即软件,而且是一种新型的软件. 这种"互联网软件"采用客户端/服务器模式,建立在分布式体系上,通过互联网通信,具有高延时(high latency).高并发等特点. 网站开发,完全可以采用软件开发的模式.但是传统上,软件和网络是两个不同的领域,很少有交集:软件开发主要针对单机环境,网络则主要研究系统之间的通信.互联网的兴起,使得这两个领域开始融合,现在我们必须考虑,如何开发在互联网环境中使用的软件. RESTful架构,就是目前最流行的一种互联网软件架构.它…
WebApi系列文章 [01]浅谈HTTP在WebApi开发中的运用 [02]聊聊WebApi体系结构 [03]详解WebApi参数的传递 [04]详解WebApi测试和PostMan [05]浅谈WebApi Cores [06]详解WebApi 异常处理 [07]用WebAPI写个基于EF的CURD [08]浅谈WebAPI身份认证 [09]详解系列化和模型绑定 [10]浅谈WebApi如何配合Mvc有效工作 [11]浅谈API Reference [12]浅谈接口在软件架构中的作用 [13…
一.前言 只有光头才能变强 认识我的朋友可能都知道我这阵子去实习啦,去的公司说是用SpringCloud(但我觉得使用的力度并不大啊~~)... 所以,这篇主要来讲讲SpringCloud的一些基础的知识.(我就是现学现卖了,主要当做我学习SpringCloud的笔记吧!)当然了,我的水平是有限的,可能会有一些理解错的的概念/知识点,还请大家不吝在评论区指正啊~~ SpringCloud GitHub Demo(看完文章的同学可以自己练手玩玩): https://github.com/Zhong…
一.前言 只有光头才能变强 认识我的朋友可能都知道我这阵子去实习啦,去的公司说是用SpringCloud(但我觉得使用的力度并不大啊~~)... 所以,这篇主要来讲讲SpringCloud的一些基础的知识.(我就是现学现卖了,主要当做我学习SpringCloud的笔记吧!)当然了,我的水平是有限的,可能会有一些理解错的的概念/知识点,还请大家不吝在评论区指正啊~~ SpringCloud GitHub Demo(看完文章的同学可以自己练手玩玩): https://github.com/Zhong…
https://www.cnblogs.com/Java3y/p/9479410.html 二.集群/分布式/微服务/SOA是什么? 像我这种技术小白,看到这些词(集群/分布式/微服务/SOA)的时候,感觉就是遥不可及的(高大尚的技术!!).就好像刚学Java面向对象的时候,在论坛上翻阅资料的时候,无意看到"面向切面编程",也认为这是遥不可及的(高大尚的技术!!). 但真正接触到"面向切面编程"的时候,发现原来就是如此啊,也没什么大不了的.只不过当时被它的名字给唬住…
原文转自 http://blog.csdn.net/educast/article/details/31359835 1.gloox Ans. 老牌库,推荐 gloox是一个稳定功能完整的XMPP客户端库, 使用ANSI C++编写, 使用它编写标准客户非常容易, 并能将Jabber/XMPP功能集成到现有的应用程序中, gloox遵循GNU GPL许可协议, 支持商业许可. 特点: 1. 易于使用 2. 可扩展性好 3. 平台无关性(支持多种操作系统) 4. 完整的开发文档 5. 完全支持XM…
Kubernetes API的使用方式 Kubernetes API属于声明式API编程, 它和常用的命令式编程有一些区别. 通俗的说,命令式编程是第一人称,我要做什么,我要怎么做. 操作系统最喜欢这种编程范式了, 操作系统几乎不用"思考", 只要一对一的将代码翻译成指令就可以了. 而声明式编程则类似于"第二人称", 也就是你要做什么. 有点"产品经理"和"开发"之间的关系, "产品经理"只负责提需求,而&…
一.前言 原文地址:https://mp.weixin.qq.com/s/mwn2X0G9UgUDz1sgGgL1mA 认识我的朋友可能都知道我这阵子去实习啦,去的公司说是用SpringCloud(但我觉得使用的力度并不大啊~~)… 所以,这篇主要来讲讲SpringCloud的一些基础的知识.(我就是现学现卖了,主要当做我学习SpringCloud的笔记吧!)当然了,我的水平是有限的,可能会有一些理解错的的概念/知识点,还请大家不吝在评论区指正啊~~ SpringCloud GitHub Dem…
一.前言 只有光头才能变强 认识我的朋友可能都知道我这阵子去实习啦,去的公司说是用SpringCloud(但我觉得使用的力度并不大啊~~)... 所以,这篇主要来讲讲SpringCloud的一些基础的知识.(我就是现学现卖了,主要当做我学习SpringCloud的笔记吧!)当然了,我的水平是有限的,可能会有一些理解错的的概念/知识点,还请大家不吝在评论区指正啊~~ SpringCloud GitHub Demo(看完文章的同学可以自己练手玩玩): github.com/ZhongFuChen……