如何在 OpenAPI 中将 API 标记为未使用 3.x
How to mark APIs as unused in OpenAPI 3.x
如何在 OpenAPI 3.x 中将 API 标记为未使用，当库尚未准备好供打算使用 API 的其他微服务使用时
注意：目前，我们构建了很多 API(s)，它们处于不同的开发阶段。有没有办法对此进行注释，以便其他开发人员知道还有 API(s) 仍在进行中
OpenAPI 规范直到 3.1.0 没有定义描述 API.
成熟度级别的方法
有一个 proposal 关于添加 /info/lifecycle 来描述生命周期和成熟度信息。但是好像没有定论
您可以定义打开API extension to store the information. Just like the /info/x-maturity in Smart API Specification:
x-maturity enum : Maturity of the API. Values to use: development, staging, production.
另一种方法是在 API 版本中表示您的 API maturity/readiness。 semantic versioning 允许您在版本中为 pre-release 添加额外的标签。例如，任何开发人员都应该知道版本为 1.0.0-alpha.1 或 1.0.0-dev.1 的 API 仍在开发中，尚未准备好使用。
A pre-release version MAY be denoted by appending a hyphen and a
series of dot separated identifiers immediately following the patch
version. ...... A pre-release
version indicates that the version is unstable and might not satisfy
the intended compatibility requirements as denoted by its associated
normal version. Examples: 1.0.0-alpha, 1.0.0-alpha.1, 1.0.0-0.3.7,
1.0.0-x.7.z.92, 1.0.0-x-y-z.–.
如何在 OpenAPI 3.x 中将 API 标记为未使用，当库尚未准备好供打算使用 API 的其他微服务使用时
注意：目前，我们构建了很多 API(s)，它们处于不同的开发阶段。有没有办法对此进行注释，以便其他开发人员知道还有 API(s) 仍在进行中
OpenAPI 规范直到 3.1.0 没有定义描述 API.
成熟度级别的方法有一个 proposal 关于添加 /info/lifecycle 来描述生命周期和成熟度信息。但是好像没有定论
您可以定义打开API extension to store the information. Just like the /info/x-maturity in Smart API Specification:
x-maturityenum : Maturity of the API. Values to use:development,staging,production.
另一种方法是在 API 版本中表示您的 API maturity/readiness。 semantic versioning 允许您在版本中为 pre-release 添加额外的标签。例如，任何开发人员都应该知道版本为 1.0.0-alpha.1 或 1.0.0-dev.1 的 API 仍在开发中，尚未准备好使用。
A pre-release version MAY be denoted by appending a hyphen and a series of dot separated identifiers immediately following the patch version. ...... A pre-release version indicates that the version is unstable and might not satisfy the intended compatibility requirements as denoted by its associated normal version. Examples: 1.0.0-alpha, 1.0.0-alpha.1, 1.0.0-0.3.7, 1.0.0-x.7.z.92, 1.0.0-x-y-z.–.