Baixe a especificação OpenAPI:Baixar
Uma API totalmente gerenciada para ler, escrever e agregar dados no MongoDB Atlas. A API de dados é alimentada pelo Atlas Functions sem servidor e protegida com autenticação de usuário e permissões baseadas em função. Para saber mais sobre a API de dados, consulte API de dados do Atlas.
Antes de usar a API de dados, você deve habilitá-la e configurá-la em um aplicativo do Atlas App Services. A configuração controla como os usuários do aplicativo autenticam e autorizam solicitações, e interagem com a API.
Para saber como começar a usar a API de dados em seu aplicativo, consulte Configurar a API de dados.
Sua configuração de API de dados no App Services controla como os usuários autenticam suas solicitações de API. Na maioria dos casos, você usará a autenticação do aplicativo, que permite ao usuário fazer login com um dos fornecedores de autenticação do aplicativo. O usuário pode digitar suas credenciais de login diretamente em cada solicitação ou inserir um token de acesso reutilizável para abrir uma sessão autenticada.
Para saber mais, consulte Autenticar solicitações de API de dados.
Encontre um único documento que corresponda a uma query.
| Fonte de dados necessário | string O nome de uma fonte de dados vinculada do MongoDB Atlas. Normalmente é |
| banco de dados necessário | string O nome de um banco de dados na fonte de dados especificada. |
| collection necessário | string O nome de uma collection no banco de dados especificado. |
| filtro, filtro necessário | objeto Um filtro de query do MongoDB que corresponda aos documentos. Para obter uma lista de todos os operadores de query compatíveis com a Data API, consulte Operadores de query. |
objeto Uma projeção do MongoDB para documentos correspondentes retornados pela operação. |
{- "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"
}
}Encontrar vários documentos que correspondam a uma query.
| Fonte de dados necessário | string O nome de uma fonte de dados vinculada do MongoDB Atlas. Normalmente é |
| banco de dados necessário | string O nome de um banco de dados na fonte de dados especificada. |
| collection necessário | string O nome de uma collection no banco de dados especificado. |
| filtro, filtro necessário | objeto Um filtro de query do MongoDB que corresponda aos documentos. Para obter uma lista de todos os operadores de query compatíveis com a Data API, consulte Operadores de query. |
objeto Uma projeção do MongoDB para documentos correspondentes retornados pela operação. | |
| espécie | objeto Uma expressão de classificação do MongoDB que indica nomes e direções de campos classificados. |
| limite | número O número máximo de documentos correspondentes para incluir na resposta. |
| ignorar | número O número de documentos correspondentes para omitir da resposta. |
{- "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"
}
]
}Insira um único documento em uma coleção.
| Fonte de dados necessário | string O nome de uma fonte de dados vinculada do MongoDB Atlas. Normalmente é |
| banco de dados necessário | string O nome de um banco de dados na fonte de dados especificada. |
| collection necessário | string O nome de uma collection no banco de dados especificado. |
| documento necessário | objeto Um documento para inserir na coleção. |
{- "dataSource": "mongodb-atlas",
- "database": "todo",
- "collection": "tasks",
- "document": {
- "status": "open${{ env.BUNDLED_SPEC_FILEPATH }}",
- "text": "Do the dishes"
}
}{- "insertedId": "6193504e1be4ab27791c8133"
}Inserir vários documentos em uma collection.
| Fonte de dados necessário | string O nome de uma fonte de dados vinculada do MongoDB Atlas. Normalmente é |
| banco de dados necessário | string O nome de um banco de dados na fonte de dados especificada. |
| collection necessário | string O nome de uma collection no banco de dados especificado. |
| documentos necessário | Array de objetos Uma lista de documentos para inserir na coleção. |
{- "dataSource": "mongodb-atlas",
- "database": "todo",
- "collection": "tasks",
- "documents": [
- {
- "status": "open",
- "text": "Mop the floor"
}, - {
- "status": "open",
- "text": "Clean the windows"
}
]
}{- "insertedIds": [
- "61935189ec53247016a623c9",
- "61935189ec53247016a623ca"
]
}Atualizar um único documento em uma collection.
| Fonte de dados necessário | string O nome de uma fonte de dados vinculada do MongoDB Atlas. Normalmente é |
| banco de dados necessário | string O nome de um banco de dados na fonte de dados especificada. |
| collection necessário | string O nome de uma collection no banco de dados especificado. |
| filtro, filtro necessário | objeto Um filtro de query do MongoDB que corresponda aos documentos. Para obter uma lista de todos os operadores de query compatíveis com a Data API, consulte Operadores de query. |
| update necessário | objeto Uma expressão de atualização do MongoDB para aplicar aos documentos correspondentes. Para ver uma lista de todos os operadores de atualização compatíveis com a API de dados, consulte Operadores de atualização. |
| upsert | booleano Padrão: false Quando |
{- "dataSource": "mongodb-atlas",
- "database": "todo",
- "collection": "tasks",
- "filter": {
- "_id": {
- "$oid": "642f1bb5cee4111898828bf6"
}
}, - "update": {
- "$set": {
- "status": "complete"
}
}, - "upsert": false
}{- "matchedCount": 1,
- "modifiedCount": 1
}Atualize vários documentos em uma coleção.
| Fonte de dados necessário | string O nome de uma fonte de dados vinculada do MongoDB Atlas. Normalmente é |
| banco de dados necessário | string O nome de um banco de dados na fonte de dados especificada. |
| collection necessário | string O nome de uma collection no banco de dados especificado. |
| filtro, filtro necessário | objeto Um filtro de query do MongoDB que corresponda aos documentos. Para obter uma lista de todos os operadores de query compatíveis com a Data API, consulte Operadores de query. |
| update necessário | objeto Uma expressão de atualização do MongoDB para aplicar aos documentos correspondentes. Para ver uma lista de todos os operadores de atualização compatíveis com a API de dados, consulte Operadores de atualização. |
| upsert | booleano Padrão: false Quando |
{- "dataSource": "mongodb-atlas",
- "database": "todo",
- "collection": "tasks",
- "filter": {
- "status": "open"
}, - "update": {
- "$set": {
- "status": "complete"
}
}
}{- "matchedCount": 12,
- "modifiedCount": 12
}Exclua um único documento que corresponda a uma query.
| Fonte de dados necessário | string O nome de uma fonte de dados vinculada do MongoDB Atlas. Normalmente é |
| banco de dados necessário | string O nome de um banco de dados na fonte de dados especificada. |
| collection necessário | string O nome de uma collection no banco de dados especificado. |
| filtro, filtro | objeto Um filtro de query do MongoDB que corresponda aos documentos. Para obter uma lista de todos os operadores de query compatíveis com a Data API, consulte Operadores de query. |
{- "dataSource": "mongodb-atlas",
- "database": "todo",
- "collection": "tasks",
- "filter": {
- "text": "Do the dishes"
}
}{- "deletedCount": 1
}Excluir vários documentos que correspondam a uma query.
| Fonte de dados necessário | string O nome de uma fonte de dados vinculada do MongoDB Atlas. Normalmente é |
| banco de dados necessário | string O nome de um banco de dados na fonte de dados especificada. |
| collection necessário | string O nome de uma collection no banco de dados especificado. |
| filtro, filtro | objeto Um filtro de query do MongoDB que corresponda aos documentos. Para obter uma lista de todos os operadores de query compatíveis com a Data API, consulte Operadores de query. |
{- "dataSource": "mongodb-atlas",
- "database": "todo",
- "collection": "tasks",
- "filter": {
- "status": "complete"
}
}{- "deletedCount": 12
}Execute um aggregation pipeline.
| Fonte de dados necessário | string O nome de uma fonte de dados vinculada do MongoDB Atlas. Normalmente é |
| banco de dados necessário | string O nome de um banco de dados na fonte de dados especificada. |
| collection necessário | string O nome de uma collection no banco de dados especificado. |
| gasoduto necessário | Array de objetos Uma variedade de estágios de agregação. |
[- {
- "$groupBy": {
- "_id": "$status",
- "count": {
- "$sum": 1
}, - "tasks": {
- "$push": "$text"
}
}
}, - {
- "$sort": {
- "count": 1
}
}
][- {
- "$groupBy": {
- "_id": "$status",
- "count": {
- "$sum": 1
}, - "tasks": {
- "$push": "$text"
}
}
}, - {
- "$sort": {
- "count": 1
}
}
]