OpenAPI 사양 다운로드: 다운로드
완전 관리형 API로 MongoDB Atlas에서 데이터를 읽고, 쓰고, 애그리게이션할 수 있습니다. Data API는 서버리스 Atlas 함수로 구동되며 사용자 인증 및 역할 기반 권한으로 보호됩니다. 데이터 API에 대해 자세히 알아보려면 Atlas 데이터 API를 참조하세요.
데이터 API를 사용하려면 먼저 Atlas App Services 앱에서 데이터 API를 활성화하고 구성해야 합니다. 구성은 앱 사용자가 요청을 인증하고 승인하며 API와 상호 작용하는 방법을 제어합니다.
앱에서 데이터 API 사용을 시작하는 방법을 알아보려면 데이터 API 설정을 참조하세요.
App Services의 데이터 API 구성은 사용자가 API 요청을 인증하는 방법을 제어합니다. 대부분의 경우 사용자가 앱의 인증 제공자 중 하나를 사용하여 로그인할 수 있게 해주는 애플리케이션 인증을 사용하게 됩니다. 사용자는 모든 요청에서 직접 로그인 자격 증명을 제공하거나 인증된 세션에 재사용 가능한 액세스 토큰을 제공할 수 있습니다.
자세한 내용은 데이터 API 요청 인증을 참조하세요.
쿼리와 일치하는 단일 문서를 찾습니다.
| dataSource 필수 | 문자열 연결된 MongoDB Atlas 데이터 소스의 이름입니다. 이는 일반적으로 |
| database 필수 | 문자열 지정된 데이터 소스에 있는 데이터베이스의 이름입니다. |
| 컬렉션 필수 | 문자열 지정된 데이터베이스에 있는 컬렉션의 이름입니다. |
| 필터 필수 | 객체 문서와 일치하는 MongoDB 쿼리 필터입니다. 데이터 API가 지원하는 모든 쿼리 연산자 목록은 쿼리 연산자를 참조하세요. |
객체 작업에서 반환된 일치하는 문서에 대한 MongoDB 프로젝션입니다. |
{- "dataSource": "mongodb-atlas",
- "database": "todo",
- "collection": "tasks",
- "filter": {
- "text": "Do the dishes"
}, - "projection": {
- "status": 1,
- "text": 1
}
}{- "document": {
- "_id": "6193504e1be4ab27791c8133",
- "status": "open",
- "text": "Do the dishes"
}
}쿼리와 일치하는 여러 문서를 찾습니다.
| dataSource 필수 | 문자열 연결된 MongoDB Atlas 데이터 소스의 이름입니다. 이는 일반적으로 |
| database 필수 | 문자열 지정된 데이터 소스에 있는 데이터베이스의 이름입니다. |
| 컬렉션 필수 | 문자열 지정된 데이터베이스에 있는 컬렉션의 이름입니다. |
| 필터 필수 | 객체 문서와 일치하는 MongoDB 쿼리 필터입니다. 데이터 API가 지원하는 모든 쿼리 연산자 목록은 쿼리 연산자를 참조하세요. |
객체 작업에서 반환된 일치하는 문서에 대한 MongoDB 프로젝션입니다. | |
| sort | 객체 정렬된 필드 이름과 방향을 나타내는 MongoDB 정렬 표현식입니다. |
| limit | 숫자 응답에 포함할 일치하는 문서의 최대 수입니다. |
| 건너뛰기 | 숫자 응답에서 생략할 일치하는 문서 수입니다. |
{- "dataSource": "mongodb-atlas",
- "database": "todo",
- "collection": "tasks",
- "filter": {
- "status": "complete"
}, - "projection": {
- "text": 1,
- "completedAt": 1
}, - "sort": {
- "completedAt": 1
}, - "limit": 10
}{- "documents": [
- {
- "_id": "6193504e1be4ab27791c8133",
- "text": "Do the dishes",
- "completedAt": "2022-05-16T20:22:01.104Z"
}, - {
- "_id": "6194604e1d38dc33792d8257",
- "text": "Feed the dog",
- "completedAt": "2022-05-17T05:12:42.828Z"
}
]
}단일 문서를 컬렉션에 삽입
| dataSource 필수 | 문자열 연결된 MongoDB Atlas 데이터 소스의 이름입니다. 이는 일반적으로 |
| database 필수 | 문자열 지정된 데이터 소스에 있는 데이터베이스의 이름입니다. |
| 컬렉션 필수 | 문자열 지정된 데이터베이스에 있는 컬렉션의 이름입니다. |
| 문서 필수 | 객체 컬렉션에 삽입할 문서입니다. |
{- "dataSource": "mongodb-atlas",
- "database": "todo",
- "collection": "tasks",
- "document": {
- "status": "open${{ env.BUNDLED_SPEC_FILEPATH }}",
- "text": "Do the dishes"
}
}{- "insertedId": "6193504e1be4ab27791c8133"
}컬렉션에 여러 문서를 삽입할 수 있습니다.
| dataSource 필수 | 문자열 연결된 MongoDB Atlas 데이터 소스의 이름입니다. 이는 일반적으로 |
| database 필수 | 문자열 지정된 데이터 소스에 있는 데이터베이스의 이름입니다. |
| 컬렉션 필수 | 문자열 지정된 데이터베이스에 있는 컬렉션의 이름입니다. |
| 문서 필수 | 의 배열 객체 컬렉션에 삽입할 문서의 목록입니다. |
{- "dataSource": "mongodb-atlas",
- "database": "todo",
- "collection": "tasks",
- "documents": [
- {
- "status": "open",
- "text": "Mop the floor"
}, - {
- "status": "open",
- "text": "Clean the windows"
}
]
}{- "insertedIds": [
- "61935189ec53247016a623c9",
- "61935189ec53247016a623ca"
]
}컬렉션에서 단일 문서를 업데이트합니다.
| dataSource 필수 | 문자열 연결된 MongoDB Atlas 데이터 소스의 이름입니다. 이는 일반적으로 |
| database 필수 | 문자열 지정된 데이터 소스에 있는 데이터베이스의 이름입니다. |
| 컬렉션 필수 | 문자열 지정된 데이터베이스에 있는 컬렉션의 이름입니다. |
| 필터 필수 | 객체 문서와 일치하는 MongoDB 쿼리 필터입니다. 데이터 API가 지원하는 모든 쿼리 연산자 목록은 쿼리 연산자를 참조하세요. |
| update 필수 | 객체 일치하는 문서에 적용할 MongoDB 업데이트 표현식입니다. 데이터 API가 지원하는 모든 업데이트 연산자 목록은 업데이트 연산자를 참조하세요. |
| 업서트 | 부울 기본값입니다: 거짓
|
{- "dataSource": "mongodb-atlas",
- "database": "todo",
- "collection": "tasks",
- "filter": {
- "_id": {
- "$oid": "642f1bb5cee4111898828bf6"
}
}, - "update": {
- "$set": {
- "status": "complete"
}
}, - "upsert": false
}{- "matchedCount": 1,
- "modifiedCount": 1
}컬렉션에 있는 여러 문서를 업데이트합니다.
| dataSource 필수 | 문자열 연결된 MongoDB Atlas 데이터 소스의 이름입니다. 이는 일반적으로 |
| database 필수 | 문자열 지정된 데이터 소스에 있는 데이터베이스의 이름입니다. |
| 컬렉션 필수 | 문자열 지정된 데이터베이스에 있는 컬렉션의 이름입니다. |
| 필터 필수 | 객체 문서와 일치하는 MongoDB 쿼리 필터입니다. 데이터 API가 지원하는 모든 쿼리 연산자 목록은 쿼리 연산자를 참조하세요. |
| update 필수 | 객체 일치하는 문서에 적용할 MongoDB 업데이트 표현식입니다. 데이터 API가 지원하는 모든 업데이트 연산자 목록은 업데이트 연산자를 참조하세요. |
| 업서트 | 부울 기본값입니다: 거짓
|
{- "dataSource": "mongodb-atlas",
- "database": "todo",
- "collection": "tasks",
- "filter": {
- "status": "open"
}, - "update": {
- "$set": {
- "status": "complete"
}
}
}{- "matchedCount": 12,
- "modifiedCount": 12
}쿼리와 일치하는 단일 문서를 삭제합니다.
| dataSource 필수 | 문자열 연결된 MongoDB Atlas 데이터 소스의 이름입니다. 이는 일반적으로 |
| database 필수 | 문자열 지정된 데이터 소스에 있는 데이터베이스의 이름입니다. |
| 컬렉션 필수 | 문자열 지정된 데이터베이스에 있는 컬렉션의 이름입니다. |
| 필터 | 객체 문서와 일치하는 MongoDB 쿼리 필터입니다. 데이터 API가 지원하는 모든 쿼리 연산자 목록은 쿼리 연산자를 참조하세요. |
{- "dataSource": "mongodb-atlas",
- "database": "todo",
- "collection": "tasks",
- "filter": {
- "text": "Do the dishes"
}
}{- "deletedCount": 1
}쿼리와 일치하는 여러 문서를 삭제합니다.
| dataSource 필수 | 문자열 연결된 MongoDB Atlas 데이터 소스의 이름입니다. 이는 일반적으로 |
| database 필수 | 문자열 지정된 데이터 소스에 있는 데이터베이스의 이름입니다. |
| 컬렉션 필수 | 문자열 지정된 데이터베이스에 있는 컬렉션의 이름입니다. |
| 필터 | 객체 문서와 일치하는 MongoDB 쿼리 필터입니다. 데이터 API가 지원하는 모든 쿼리 연산자 목록은 쿼리 연산자를 참조하세요. |
{- "dataSource": "mongodb-atlas",
- "database": "todo",
- "collection": "tasks",
- "filter": {
- "status": "complete"
}
}{- "deletedCount": 12
}집계 파이프라인을 실행합니다.
| dataSource 필수 | 문자열 연결된 MongoDB Atlas 데이터 소스의 이름입니다. 이는 일반적으로 |
| database 필수 | 문자열 지정된 데이터 소스에 있는 데이터베이스의 이름입니다. |
| 컬렉션 필수 | 문자열 지정된 데이터베이스에 있는 컬렉션의 이름입니다. |
| 파이프라인 필수 | 의 배열 객체 집계 단계의 배열입니다. |
[- {
- "$groupBy": {
- "_id": "$status",
- "count": {
- "$sum": 1
}, - "tasks": {
- "$push": "$text"
}
}
}, - {
- "$sort": {
- "count": 1
}
}
][- {
- "$groupBy": {
- "_id": "$status",
- "count": {
- "$sum": 1
}, - "tasks": {
- "$push": "$text"
}
}
}, - {
- "$sort": {
- "count": 1
}
}
]