swaggerApi文档规范

@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。

这份后台代码是swagger的jar包,包名叫v2.io.swagger.models,感兴趣的可以自己搜下

发布了16 篇原创文章 · 获赞 3 · 访问量 1365

猜你喜欢

转载自blog.csdn.net/weixin_40631132/article/details/88261643