Info 对象

这个对象提供 API 的元数据。如果客户端需要时可能会用到这些元数据，而且可能会被呈现在编辑工具或者文档生成工具中。

固定字段

字段名	类型	描述
title	string	必选. 应用的名称。
description	string	对应用的简短描述。 CommonMark syntax 可以被用来表示富文本呈现。
termsOfService	string	指向服务条款的 URL 地址，必须是 URL 地址格式。
contact	Contact 对象	所开放的 API 的联系人信息。
license	License 对象	所开放的 API 的证书信息。
version	string	必选. API 文档的版本信息（注意：这个版本和开放 API 规范版本没有任何关系）。

Info 对象示例

{
  "title": "Sample Pet Store App",
  "description": "This is a sample server for a pet store.",
  "termsOfService": "http://example.com/terms/",
  "contact": {
    "name": "API Support",
    "url": "http://www.example.com/support",
    "email": "support@example.com"
  },
  "license": {
    "name": "Apache 2.0",
    "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
  },
  "version": "1.0.1"
}

title: Sample Pet Store App
description: This is a sample server for a pet store.
termsOfService: http://example.com/terms/
contact:
  name: API Support
  url: http://www.example.com/support
  email: support@example.com
license:
  name: Apache 2.0
  url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.1