OpenAPI工具、生成器

喜欢打篮球的普通人

已于 2024-03-01 18:36:51 修改

阅读量2.6k

点赞数 4

分类专栏： openAPI 文章标签： http

于 2024-03-01 09:44:34 首次发布

本文链接：https://blog.csdn.net/u011436427/article/details/136376967

版权

文章目录

一、OpenAPI工具
二、OpenAPI文档
四、OpenAPI Generator
五、API规范(契约)
六、Example
参考

一、OpenAPI工具

OpenAPI.Tools

OpenApi 文档编辑器，推荐使用：Stoplight Studio
Mock服务器，推荐使用Prism
代码生成工具：OpenAPI Generator，github

二、OpenAPI文档

Open API Specification

文档可以使用yaml或者json描述
Open API规范的内容：路径，http操作；基本信息；联系方式；授权路径；访问控制；服务器
OpenAPI文档实际上就是HTTP操作描述的集合
设计API的过程就是编写OpenAPI文档的过程，后续的开发工作会基于这个OpenAPI文档进行
建议使用Stoplight studio创建的OpenAPI文档

Stoplight

Stoplight studio，集成IDE
Spectral，验证
Prism，模拟服务器

eg：Stoplight studio创建一个支付的OpenAPI文档

在这里插入图片描述

（1）设置一些基本信息

在这里插入图片描述

（2）创建一个路径用于查询支付状态
在这里插入图片描述
使用（3）中创建的Response在这里使用这个Response

在这里插入图片描述

（3）创建一个Response
在这里插入图片描述

（4）创建一个路径用于创建支付记录
在这里插入图片描述
保存项目工程

在这里插入图片描述

工程最终就是一个yaml文件

openapi: 3.1.0

# ASAM SOVD V1.0.0

# © by ASAM e.V., 2022

# SOVD API Fault Data Types
# This file is informative. The normative REST API definition is published in the specification.


# Any use is limited to the scope described in the ASAM license terms.
# See http://www.asam.net/license.html  for further details.

info:
  title: SOVD API Fault Data Types
  license:
    name: Licensing Terms for Grant of Rights to Use ASAM Products
    url: https://www.asam.net/license/
  version: 1.0.0
  description: >-
    Data types for representing faults

paths: {
   }

components:
  # ==========================================================================
  # Schema definitions
  schemas:
    # ------------------------------------------------------------------------