빠른 시작: 모든 데이터베이스에 대해 Microsoft의 Data API Builder와 함께 App Builder 사용
이 가이드는 모든 데이터베이스와 함께 Data API Builder를 설정하고 사용하는 단계별 프로세스를 제공합니다. 지원되는 데이터베이스의 전체 목록 - SQL Server, MySQL 및 PostgreSQL 등. 이 지침에 따라 native OpenAPI, REST 끝점용 Swagger를 만들고 데이터베이스를 효과적으로 관리합니다.
주요 기능
- 관계형 테이블, 뷰 및 저장 프로시저 지원
- 여러 개의 동시 데이터 소스 지원
- REST 끝점
- POST, GET, PUT, PATCH, DELETE
- 필터링, 정렬 및 페이지 매김
- 메모리 내 캐시
- OpenAPI 지원
- 전용 CLI를 통한 쉬운 개발
- 오픈 소스 및 무료
이 다이어그램은 Data API Builder 아키텍처의 모든 구성 요소 간의 관계를 분석합니다.
DAB Architecture
1. NuGet에서 Microsoft.DataApiBuilder 패키지를 .NET 도구로 설치
시작하려면 dotnet tool install을 사용하여 —global 인수와 함께 Microsoft.DataApiBuilder의 최신 버전을 설치합니다:
dotnet tool install -g Microsoft.DataApiBuilder
Note
패키지가 이미 설치되어 있으면 dotnet tool update를 사용하여 패키지를 대신 업데이트합니다
dotnet tool update --global Microsoft.DataApiBuilder
자세한 내용은 공식 설명서를 참조합니다: .
2. 데이터베이스 구성
데이터베이스가 설정되어 있는지 확인합니다. SQL Server Management Studio, MySQL Workbench 또는 다른 데이터베이스 관리 도구를 사용하여 데이터베이스를 만들고 구성할 수 있습니다. 이 가이드에서는 MSSQL 데이터베이스의 예제를 제공합니다.
3. 구성 파일을 통해 생성된 Data API Builder의 REST 끝점
Data API Builder는 연결된 데이터베이스에서 테이블, 뷰 및 저장 프로시저에 액세스할 수 있는 RESTful 웹 API를 제공합니다. 엔터티는 Data API Builder의 런타임 구성에서 데이터베이스 개체를 나타냅니다. 엔터티가 REST API 끝점에서 사용 가능하려면 런타임 구성에서 설정해야 합니다.
이제 DAB CLI를 사용하여 기본 구성 파일을 만듭니다. 공식 설명서. 이 구성 파일은 Data API Builder가 데이터베이스와 상호 작용하는 방식을 정의하는 데 필요합니다.
다음 명령을 실행하여 MSSQL 연결 문자열을 기반으로 구성 파일을 초기화합니다.
dab init --database-type "mssql" --host-mode "Development" --connection-string "Server=DEV-ZKOLEV4\SQLEXPRESS;User Id=INFRAGISTICS/ZKolev;Database=NorthwindCRUD;Integrated Security=True;TrustServerCertificate=True;Encrypt=False;"
REST API가 작동할 엔터티 추가
구성 파일에 엔터티(예: Products)를 추가합니다:
dab add Products --source "Products" --permissions "anonymous:*"
현재 dab-config.json 구성 파일 관찰
파일에는 단일 엔터티, REST API 끝점이 포함된 기본 API 구현이 포함되어야 합니다:
Note
필요한 경우 CORS를 사용하도록 설정합니다(선택 사항). 원본 간 요청을 허용하려면 custom-config.json에 다음을 추가하여 구성에서 CORS를 사용하도록 설정합니다:
"origins": ["*"]
{
"$schema": "https://github.com/Azure/data-api-builder/releases/download/v1.4.26/dab.draft.schema.json",
"data-source": {
"database-type": "mssql",
"connection-string": "Server=DEV-ZKOLEV4\\SQLEXPRESS;User Id=INFRAGISTICS/ZKolev;Database=NorthwindCRUD;Integrated Security=True;TrustServerCertificate=True;Encrypt=False;",
"options": {
"set-session-context": false
}
},
"runtime": {
"rest": {
"enabled": true,
"path": "/api",
"request-body-strict": true
},
"graphql": { ... },
"host": {
"cors": {
"origins": [
"*"
],
"allow-credentials": false
},
"authentication": {
"provider": "StaticWebApps"
},
"mode": "development"
}
},
"entities": {
...
"Products": {
"source": {
"object": "Products",
"type": "table"
},
"graphql": {
"enabled": true,
"type": {
"singular": "Products",
"plural": "Products"
}
},
"rest": {
"enabled": true
},
"permissions": [
{
"role": "anonymous",
"actions": [
{
"action": "*"
}
]
}
]
}
}
}
4. REST API 테스트
이제 Data API Builder 도구를 시작하여 모든 것이 올바르게 설정되었는지 확인합니다.
dab start
출력입니다. API가 실행되면 http://localhost:5000/swagger/index.html 에서 액세스할 수 있습니다.
Successfully completed runtime initialization.
info: Microsoft.Hosting.Lifetime[14]
Now listening on: <http://localhost:5000>
info: Microsoft.Hosting.Lifetime[0]
이 URL은 API 끝점을 테스트할 수 있는 Swagger UI를 엽니다.
Swagger DAB Example
6. 새로 만든 REST API와 함께 App Builder 사용 시작
DAB in AB
6. 일반적인 문제 해결
다음은 일반적인 문제 및 해결책입니다:
-
App Builder에서 CRUD는 Grid에서만 작동하고, Form 구성 요소의 경우 현재 진행 중인 OpenAPI 사양에서 누락된 부분이 있습니다.
-
CORS 문제. 필요한 경우 CORS를 사용하도록 설정하는 방법:
"host": {
"cors": {
"origins": [
"*"
],
"allow-credentials": false
},
"authentication": {
"provider": "StaticWebApps"
},
"mode": "development"
}
-
OpenID Connect 지원 제안 - data-api-builder GitHub의 문제.
-
DELETE 끝점이 작동하지 않습니까? 엔터티에 대한 권한에서 DELETE 작업이 활성화되어 있는지 확인합니다(예: “anonymous:*“에 DELETE 포함).
-
연결 문자열 문제입니까? 연결 문자열에서 사용자 이름, 암호 및 인증 방법(예: Windows 인증 또는 SQL 인증)을 다시 확인합니다.
