0
API 안정성 인덱스는 API 문서에서 중요합니다. 현재 Swashbuckle을 사용하여 ASP.NET API로 작성된 API를 문서화하고 있습니다. "Stable", "Frozen"등의 API 안정성 색인을 사용하여 API를 플래그 지정하는 방법Swagger를 사용하여 API의 안정성을 플래그하는 방법이 있습니까
A
답변
1
OpenAPI/Swagger에는 API 안정성을 나타내는 필드가 없지만 vendor extension을 사용하여이를 문서화 할 수 있습니다 (예 : x-api 안정성 지수).
내가 선택한 버전 번호가 SEMVER 또는 기타에 한정되지 않음을 추가 할 수 있습니다. 많은 사람들이'-alpha','-beta' 등으로 버전을 접미사로 지정하여 출시 버전이 아님을 나타냅니다. – fehguy