openapi

1열

1답변

OpenAPI (Swagger)에서 동일한 HTTP 상태 코드에 대해 서로 다른 응답을 정의하는 방법은 무엇입니까?

기존 API에 대한 OpenAPI 사양을 작성하고 있습니다. 이 API는 성공 및 실패에 대해 상태 200을 리턴하지만 응답 구조는 다릅니다. 사용자가 성공적으로 가입 한 경우 예를 들어 는 가입 API에서, API는 다음과 같은 JSON과 상태 (200)를 보냅니다 { "result": true, "token": RANDOM_STRING

0열

1답변

SwaggerUI/YAML - 매핑 항목의 들여 쓰기가 잘못됨 : 이유를 찾을 수 없음

한 시간 이상 Swagger UI 문제에 봉착했습니다. 찾을 수없는 설명을 찾기 위해 문서 및 다양한 게시물을 검색했습니다. . paths: /projects: get: tags: - projects summary: Get projects description: operationId:

0열

2답변

openapi 2 복수 응답 유형

openapi 3에서는 oneOf/anyOf를 사용할 수 있지만 현재는 openapi 3으로 업그레이드 할 수 없다는 것을 알고 있습니다. 정의 중 하나에서 공통 속성이없는 많은 응답 유형을 사용해야합니다 기본적으로 응답은 메소드/속성이없는 인터페이스이며 여러 구현이 있습니다. 어떻게 든 openapi 2로 여러 응답 유형을 정의 할 수 있습니까? 이 응답

2열

1답변

다른 Swagger 또는 OpenAPI 파일에서 특정 끝점에 대한 Swagger 파일 생성

하나의 큰 Swagger/OpenAPI YAML 사양이 있으면 특정 API 끝점을 안전하게 추출하여 독점적으로 새 을 생성하려면 어떻게해야합니까? 이 (하나 개 들여 쓰기 이상의 정의와 같은) 특정 레벨에서 API 엔드 포인트를 쉽게 식별 할 수있다 : 나는 모든 섹션을 바로 복사 할 것 paths: /users: ... - $

1열

1답변

단일 openapi (v3) 사양에서 비인가 및 Oauth2 끝점을 모두 지정하는 방법은 무엇입니까?

나는 기존 공용 API에 대해 openapi 사양 (예 : "swagger v3")을 만들고 있습니다. 이 API에는 승인되지 않은 인증 된 엔드 포인트와 oauth2 인증 된 엔드 포인트가 있습니다. 나는 Github의 사양을 참조하고 Stackoverflow와 Google을 사용하여 검색했습니다. 단일 사용 프로토콜의 예를 찾았지만 두 개의 프로토콜이있

1열

1답변

오픈 API 상속 예제 데이터

저는 현재 구축중인 서비스에 대한 API를 정의하기 위해 OpenAPI 3.0을 사용하고 있습니다. 다른 구성 요소에서 스키마 구성 요소를 재사용 할 때 문제가 발생합니다. 예를 들어, Note 오브젝트에는 노트를 만든 사람의 Profile 오브젝트가 들어 있습니다. 예상대로 $ref 키워드를 사용하여 Profile 개체를 참조하여 작동합니다. 문제는 프로

0열

1답변

배열 내의 OpenAPI 여러 유형

여러 유형이 포함 된 배열을 허용하는 OpenAPI 3을 사용하여 재사용 가능한 스키마 구성 요소를 정의하는 데 문제가 있습니다. 각 항목 유형은 동일한 상위 클래스에서 상속되지만 특정 하위 속성을가집니다. 이것은 SwaggerHub의 model보기에서 올바르게 작동하는 것으로 보이지만 예제보기에서는 데이터가 올바르게 표시되지 않습니다. TLDR; Open

1열

2답변

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

인증이 선택적 인 다양한 엔드 포인트를 포함하는 기존 API를 문서화하려고합니다. 즉, 권한이 부여 된 사용자가 승인되지 않은 경우보다 많은 데이터가 반환됩니다. OAspec v3에서 명시 적으로 찾을 수 없습니다. 이 상황을 정의하는 코딩 트릭이 있습니까? 내 현재 해결 방법은 권한 부여를 코드하는 것이지만, 끝점 쓰기에 대한 인증은 선택 사항임을 나타냅

0열

1답변

aws_api_gateway_rest_api에 OpenAPI를 사용하는 방법

OpenAPI는 표준처럼 보이므로 terraform 리소스보다 덜 복잡하므로 사용하려고합니다. 나는 terraform이 걸릴 수 있습니다 무엇을 변환 JSON을했습니다 그러나 나는 오류 얻을 : 벨로 내 코드 module.aws_api_gateway.aws_api_gateway_rest_api.CICDAPI: body must be a single valu

1열

1답변

자주 사용하는 설명 개체를 $ Ref 할 수있는 구성 요소 개체를 사용하여 트릭을 만들 수 있습니까?

나는 requestbody> content 내에서 반복해서 설명을 반복한다. 나는 OpenAPI v3 Specification에서 드레이 기법을 찾았는데, 여기서는 사물을 단순화하기 위해 $ Ref를 사용할 수 있습니다. 아무것도 나에서 뛰어 내리지 않았다. 그래서 나는 그들이 방법을 알고 있는지 여기 전문가에게 물어볼 것이라고 생각했습니다.