如何在Swagger Editor中添加API作者信息?(OpenAPI 3.0)
在OpenAPI 3.0中添加作者信息的方法
OpenAPI 3.0规范里可以通过以下两种方式添加作者/维护者信息:
1. 使用标准的contact字段(推荐)
在OpenAPI文档的info节点下添加contact对象,Swagger Editor会自动识别并展示这部分信息,这也是OpenAPI规范定义的标准字段。
示例代码:
openapi: 3.0.3 info: title: 你的API文档标题 version: 1.0.0 description: API功能描述 contact: name: 你的姓名/团队名称 email: 联系邮箱 url: 个人/团队主页(可选)
2. 使用自定义扩展字段添加多作者信息
如果需要列出多个作者,可利用OpenAPI支持的自定义扩展字段(前缀为x-)补充,比如x-authors:
示例代码:
openapi: 3.0.3 info: title: 你的API文档标题 version: 1.0.0 description: API功能描述 contact: name: 主要维护人 email: main@example.com x-authors: - name: 作者A email: authorA@example.com - name: 作者B email: authorB@example.com
添加后,Swagger Editor会在文档的「Info」区域展示contact里的信息,自定义的x-authors字段会在扩展信息板块显示。
内容的提问来源于stack exchange,提问作者DevJu
相关产品推荐
相关产品推荐

