openapi v3에서는 끝점의 인증을 지정하는 방법은 선택 사항입니까?

Question

인증이 선택적 인 다양한 엔드 포인트를 포함하는 기존 API를 문서화하려고합니다. 즉, 권한이 부여 된 사용자가 승인되지 않은 경우보다 많은 데이터가 반환됩니다.

OAspec v3에서 명시 적으로 찾을 수 없습니다. 이 상황을 정의하는 코딩 트릭이 있습니까?

내 현재 해결 방법은 권한 부여를 코드하는 것이지만, 끝점 쓰기에 대한 인증은 선택 사항임을 나타냅니다. 이것은 효과적이며 적절합니다. 그러나 내 안에있는 순수 주의자는 다른 방법이 있는지 의아해합니다.

Answer 1

는, 보안 옵션 만드는 security 배열에 빈 요구 사항 {}을 추가하려면 :

security: 
    - {} # <---- 
    - api_key: [] 

이 엔드 포인트가 또는 보안없이 호출 할 수 있다는 것을 의미한다.

출처 : OpenAPI 사양 저장소의 this comment.

Answer 2

방금 ​​배운 것은 여러 인증 프로토콜에 맞는 해시 맵 배열을 가질 수 있다는 것입니다.

두 가지 예 :

security: # protocol A or protocol B 
    - A 
    - B 

security: protocol A and protocol B 
    - A 
     B