OpenAPI 是什么
OpenAPI 基本介绍
OpenAPI 是描述 HTTP API 的标准方式。
Smartbear于 2015年 捐赠了 OpenAPI,成立了 OpenAPI(OAI),这是一个由代表一些主要技术利益的约 40 名参与成员组成的行业联盟。
OpenAPI 做了啥
那么,OpenAPI 做了什么呢?你可以把 OpenAPI 看作是所有 API 的通用语言。OpenAPI 建立在一个通用规范的基础上,它可以让你的开发实现协作、设计优先。事实上,有许多工具可以帮助开发人员利用 OpenAPI 的强大功能来实现转换、验证、linting 和其他功能。
OpenAPI 的关键功能
为了理解 OpenAPI,(OpenAPI 规范中文版)我们可以来认识一下有关它的三个关键词 规范、定义和文档:
- OpenAPI 的规范(OAS):它定义了 API 行业的标准规范,并规定了文件的目录规范
- OpenAPI 的定义:它同样定义了 API 的格式、文件等等,并且可以用 JSON、YAML 来表示
- API 文档:让 API 能以可视化的形式展示在开发的面前,有利于团队的开发效率,并且有利于团队外的分享
OpenAPI使 API 对于团队内、团队外的人来说更加可共享、可扩展、可重用。
OpenAPI 的结构
我们可以看一下 OpenAPI 的结构:
OpenAPI 的文件大致长这样:
openapi: "3.0.0"
info:
version: 1.0.0
title: Swagger Petstore
license:
name: MIT
servers:
- url: http: //petstore.swagger.io/v1
一些有用的 OpenAPI 工具
- 编辑器:vscode、SwaggerHub、 KaiZen OpenAPI Editor
- 文档:ReDoc、Swagger UI
- 代码生成器:OpenAPI-generator、Google Gnostic、swagger-node-codegen
- 测试:Apifox、Postman
- API 管理:Apifox、Postman
使用 Apifox 管理 OpenAPI API
Apifox 是一款集 API文档、API管理、API测试于一身的超级多功能 API 工具,日常用 Apifox 来管理 OpenAPI 的 API 项目,那是再合适不过了。
Apifox 的 API 管理
Apifox 的 API 管理功能很齐全,包括
- 接口数管理
- operationID
- Mock 功能
- 请求定义、请求示例
- 响应定义、响应示例
- 唯一标识
Apifox 的自动化测试
Apifox 的自动化测试也很完善,功能包括
- 测试用例:可以测试多个接口或接口用例
- 测试套件:可以测试多个测试用例
- 可以设置循环数、延迟书、环境、线程数等参数进行运行
- 支持导出测试报告
- 支持查看单个接口的测试结果
- 支持查看测试结果的详细参数
Mock 功能
Apifox 支持 Mock 功能,定义完接口响应之后,通过本地 Mock 功能可得到 Mock 数据
点击 发送,即可获取 Mock 数据
导出导入 OpenAPI
Apifox 支持导出导入 OpenAPI,如果你想要进行 API 项目迁移的时候,可以考虑下这个功能,能让你以最低的成本,去进行项目迁移
关于 Apifox
- 集成了 API 文档、API 调试、API Mock、API 自动化测试 API 一体化协作平台
- 拥有更先进的 API 设计/开发/测试工具
- Apifox = Postman + Swagger + Mock + JMeter
欢迎体验一下,完全免费的哦:在线使用 Apifox