openAPI初探

本文介绍了OpenAPI的概念,它是一种用于描述HTTP API的标准,通常以.yaml或.json文件形式存在。类比于通用API文档,OpenAPI规范允许开发者使用相关工具自动生成文档、代码和进行自动测试。文中提到了Swagger作为相关工具的例子,并提供了在线编辑器openapidemo供学习和实践。此外,还分享了OpenAPI Specification v3.0.3的参考链接。
摘要由CSDN通过智能技术生成

openAPI

前言

初次接触openapi,查了些资料,仍觉得不是很理解
记录下自己的理解,不对之处,欢迎指出讨论

定义

描述http api的文档 通常是 xxx.yaml或xxx.json文件
类比通用api的说明文档

为什么用

api符合openapi规范,可使用相关工具:
文档生成工具,展示API
代码生成工具,自动生成各种编程语言的服务器端和客户端的代码
自动测试工具,测试

相关工具

swagger

openapi demo:https://editor.swagger.io/
左边是openapi文档,右边是swagger生成的ui
左边粘贴代码,右边自动生成
在这里插入图片描述

参考

OpenAPI Specification v3.0.3
https://editor.swagger.io/
https://spec.openapis.org/oas/v3.0.3
https://blog.csdn.net/xiaoyi52/article/details/121198620
https://wenku.baidu.com/view/bbe43cc6adaad1f34693daef5ef7ba0d4a736d0e.html

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值