OpenAPI 规范：什么是适合私有和内部 OpenAPI 文档的许可证？

Question

我的公司使用 Open API Spec 来组织内部 API 的文档，并通过 UI 工具（例如 redoc.ly 或 Swagger）呈现它。API 文档作为私有 git 存储库进行管理，永远不会向公众发布。

私有API文档许可

Swagger 为开源项目提供了很好的示例，例如 MIT、GPL、“Apache 2.0”，但私有 API 文档似乎没有涵盖。

https://spec.openapis.org/oas/latest.html#license-object

{
  "name": "Apache 2.0",
  "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
}

调查

我看到有些人以这种方式指定他们的许可证。

  license:
    - name: unlicensed
    - url: "www.example.com"

问题

私有 API 文档项目的合适许可证是什么？

您通常如何在私有 Open API 文档中表示许可证对象？

Answer 1

OpenAPIinfo对象支持一个termsOfService属性，该属性采用指向术语的 URL 链接。

info:
  termsOfService: https://example.com/terms

我喜欢在这些情况下使用它。