0

API stability index is important in API documentation, currently I am using Swashbuckle to document my API which is built with ASP.NET Web API, I want to ask is there a way to flag an API with API stability index such as "Stable", "Frozen" etc.

Shuping
  • 5,388
  • 6
  • 43
  • 66

1 Answers1

1

OpenAPI/Swagger does not have a field to indicate the API stability but you can use vendor extension to document it (e.g. x-api-stability-index).

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

William Cheng
  • 10,137
  • 5
  • 54
  • 79
  • 1
    I might add that the version number you choose is not limited to SEMVER or other. Many people will suffix the version with a `-alpha`, `-beta`, etc to indicate that it's not a release version. – fehguy Jun 27 '16 at 22:45