API 概述

将有关您的 API 的一般信息（例如：版本号、许可说明、联系数据、文档链接等）包含在规范中被认为是良好的实践。我们特别建议公开可用的 API 这样做；因为这将可以增加用户对您公司提供的服务的信心。要指定 API 元数据，请使用顶级 info 对象的属性

1
openapi: 3.0.0
2
info:
3
  # You application title. Required.
4
  title: Sample Pet Store App
5

6
  # API version. You can use semantic versioning like 1.0.0,
7
  # or an arbitrary string like 0.99-beta. Required.
8
  version: 1.0.0
9

10
  # API description. Arbitrary text in CommonMark or HTML.
11
  description: This is a sample server for a pet store.
12

13
  # Link to the page that describes the terms of service.
14
  # Must be in the URL format.
15
  termsOfService: http://example.com/terms/
16

17
  # Contact information: name, email, URL.
18
  contact:
19
    name: API Support
20
    email: support@example.com
21
    url: http://example.com/support
22

23
  # Name of the license and a URL to the license description.
24
  license:
25
    name: Apache 2.0
26
    url: https://apache.ac.cn/licenses/LICENSE-2.0.html
27

28
# Link to the external documentation (if any).
29
# Code or documentation generation tools can use description as the text of the link.
30
externalDocs:
31
  description: Find out more
32
  url: http://example.com

title 和 version 属性是必需的，其他属性是可选的。

参考

Info 对象

没有找到您要找的内容？向社区提问
发现错误？告诉我们