swaggerApi文档规范

最新推荐文章于 2025-06-10 17:12:40 发布

原创最新推荐文章于 2025-06-10 17:12:40 发布 · 1k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#swagger

api管理专栏收录该内容

1 篇文章

订阅专栏

本文档介绍了SwaggerApi的规范，特别是在处理第三方服务提供的不规范文档时，如何制定标准。内容包括Info对象的详细说明，如contact和license的属性规定，强调了这些属性的数量限制和类型要求，以确保文档的正确性和前端调用的顺利进行。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

@swaggerApi文档规范

SwaggerApi文档规范

最近在做一个注册服务平台，当第三方服务把他的swagger文档存储到我们数据库时可以生成调用接口的前端界面。但是第三方swagger文档是自己写的，很多地方是不符合swagger文档规范的，然后要我写一份swagger文档接口规范，于是就有了这篇文章。

网上资料

实际上网上关于文档规范还是比较多的，但是很多写的都不全，比如
https://www.cnblogs.com/chenweixuan/p/5737235.html
这篇简要说了一下swagger的根属性，但是如Info属性是没有具体显示的，所以我们唠一唠info这个属性（然后我发现这个博客发了openAPI的官网，上面写了英文的。。。）

对Info他的类型是Info Object，我看了下Info类定义如下：

在这里插入图片描述
所以可以看到除了下面三个，其他都是字符串类型，然后看第一个contact的类型：

contact的属性只能有三个，分别是name,url和email，可以少，但不可以多，否则会报错。

Liscense的属性有三个，后两个是name和url是字符串类型的。第一个是字典类型的，在前端其实也就是json对象,里面可以加入你想加入的任何字段。
然后contact的最后一个属性，也是vendorExtensions，作用和内容同Liscense。