다음을 통해 공유

Swagger/OpenAPI를 사용한 데이터 API 작성기 REST API 설명서

  • 아티클

OpenAPI 사양은 HTTP API를 문서화하기 위한 프로그래밍 언어 독립적 표준입니다. Data API Builder는 다음을 수행할 수 있는 OpenAPI 표준을 지원합니다.

  • REST를 사용하도록 설정된 모든 런타임 구성 정의 엔터티에 대한 정보를 생성합니다.
  • 정보를 OpenAPI 스키마와 일치하는 형식으로 컴파일합니다.
  • 시각적 UI(Swagger) 또는 직렬화된 파일을 통해 생성된 OpenAPI 스키마를 노출합니다.

OpenAPI 설명 문서

데이터 API 작성기에서는 제공된 런타임 구성 및 정의된 각 REST 사용 엔터티에 대한 데이터베이스 개체 메타데이터를 사용하여 OpenAPI 설명 문서를 생성합니다. 스키마 파일은 OpenAPI.NET SDK에서 제공하는 기능을 사용하여 생성됩니다. 현재 스키마 파일은 JSON 형식의 OpenAPI 사양 v3.0.1 을 준수하여 생성됩니다.

OpenAPI 설명 문서는 경로에서 Data API 작성기에서 가져올 수 있습니다.

GET /{rest-path}/openapi

참고

기본적으로 값은 rest-path 이며 api 구성할 수 있습니다. 자세한 내용은 REST 구성을 참조하세요.

SwaggerUI

Swagger UI는 생성된 OpenAPI 사양을 사용하여 서비스에 대한 정보를 제공하는 웹 기반 UI를 제공합니다.

모드에서 Development 데이터 API 작성기를 사용하면 전용 엔드포인트에서 생성된 OpenAPI 설명 문서를 볼 수 있습니다.

GET /swagger

런타임 구성 엔터티와의 명명 충돌을 방지하기 위해 "Swagger" 엔드포인트는 아래에 rest-path 중첩되지 않습니다.

관련 콘텐츠