有没有办法用Swagger标记API的稳定性

Question

API稳定性索引在API文档中很重要，目前我使用Swashbuckle来记录我使用ASP.NET Web API构建的API，我想问一下有没有办法用API稳定性索引来标记API，例如“稳定的“，”冻结“等等。

Answer 1

OpenAPI / Swagger没有用于指示API稳定性的字段，但您可以使用vendor extension来记录它（例如x-api-stability-index）。

参考：https://github.com/domaindrivendev/Swashbuckle/blob/953f9803bdf4a5051dd4ad90f8a6bc0ad8b6af3b/Swashbuckle.Dummy.Core/SwaggerExtensions/ApplySchemaVendorExtensions.cs#L10