Open API中的API ID和API名称之间的差异



在Microsoft Azure API管理中打开API规范时,我们正在提供一些名称,而Swagger规范文件也有一些名称作为标题。我们给出的名称作为API ID和Swagger中可用的标题。JSON以API显示名称出现。那么,Azure API管理中的API ID和API名称有什么区别?

拥有名称和ID的所有Azure资源是常见的。资源ID是完整的"资源路径",就像"/订阅"/.../ResourceGroups/.../提供者/..."。该路径的最后一部分是资源名称。

Name是openapi中 Contact Object的固定字段。

Name反映了识别联系人/组织的名称

Contact object中没有id字段或任何其他OpenAPI描述字段,但是OpenAPI文件可能使用户制作了id参数。

请,请参阅此示例:

parameters:
- name: id
  in: path
  description: ID of pet to use
  required: true
  schema:
    type: array
    style: simple
    items:
      type: string  

看一下operationIdoperationId是用于识别操作的可选独特字符串。如果提供,这些ID必须在API中所述的所有操作中是唯一的。

最新更新