这篇文章详细记录了我如何实现一个 OpenAPI 的艰辛历程、我把 OpenAPI 从概念、设计、实现、部署、测试、监控的整个过程详细的提供给大家学习和参考。

提纲

• 如何打造一个自己的 OPEN API
• 如何设计一个符合 RESTful 的 OpenAPI
• 使用 .Net Core 实现自己的 OpenAPI
• 使用 Java Spring Boot 实现自己的 OpenAPI
• 如何提高 OpenAPI 健壮性
• 如何实现 OpenAPI 的高可用

OpenAPI 是什么?

Open API 即开放 API，也称开放平台。 所谓的开放 API（OpenAPI）是服务型网站常见的一种应用，网站的服务商将自己的网站服务封装成一系列
API（Application Programming Interface，应用编程接口）开放出去，供第三方开发者使用，这种行为就叫做开放网站的 API，所开放的 API 就被称作 OpenAPI（开放 API ）。

RESTful API 是什么?

什么是 REST？

Representational State Transfer，翻译是”表现层状态转化”。可以总结为一句话：REST 是所有 Web 应用都应该遵守的架构设计指导原则。
面向资源是 REST 最明显的特征，对于同一个资源的一组不同的操作。资源是服务器上一个可命名的抽象概念，资源是以名词为核心来组织的，首先关注的是名词。REST 要求，必须通过统一的接口来对资源执行各种操作。对于每个资源只能执行一组有限的操作。

什么是 RESTful API？

符合 REST 设计标准的 API，即 RESTful API。REST 架构设计，遵循的各项标准和准则，就是 HTTP 协议的表现，换句话说，HTTP 协议就是属于 REST 架构的设计模式。比如，无状态，请求-响应。。。

Swagger 是什么?

Swagger™ 的目标是为 REST APIs 定义一个标准的，与语言无关的接口，使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。当服务通过 Swagger 定义，消费者就能与远程的服务互动通过少量的实现逻辑。类似于低级编程接口，Swagger 去掉了调用服务时的很多猜测。

OpenAPI 展示

Docker Engine 1 Docker Engine 2

• Docker Engine
• Zuora
• Shopify Draft Orders
• Discourse
• APIs.guru