MongoDB Atlas Data API (v1)

下载 OpenAPI 规范：下载

这是一个完全托管的 API，用于在 MongoDB Atlas 中读取、写入和聚合数据。Data API 由无服务器 Atlas Function 提供支持，并通过用户身份验证和基于角色的权限进行保护。要了解有关 Data API 的更多信息，请参阅 Atlas Data API。

设置数据 API

在使用 Data API 之前，您必须在 Atlas App Services 应用程序中启用并配置该 API。该配置控制应用程序用户如何进行身份验证，对请求进行授权以及与该 API 进行交互。

要了解如何开始在应用程序中使用 Data API，请参阅设置 Data API。

对请求进行身份验证

App Services 中的 Data API 配置控制用户如何对其 API 请求进行身份验证。在大多数情况下，您使用应用程序身份验证，这允许用户使用应用程序的身份验证提供程序之一登录。用户可以在每个请求中直接提供登录凭证，或者为经过身份验证的会话提供可重用的访问令牌。

要了解更多信息，请参阅对 Data API 请求进行身份验证。

查找一个文档

查找一个与查询匹配的文档。

授权：

AccessToken(电子邮件密码) ApiKey自定义 JWT

请求正文模式：
application/json

dataSource 必需	字符串链接的 MongoDB Atlas 数据源的名称。它通常为 `"mongodb-atlas"`，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 必需	字符串指定的数据源中的数据库名称。
集合必需	字符串指定的数据库中的集合名称。
筛选器必需	对象匹配文档的 MongoDB 查询筛选器。有关 Data API 支持的所有查询运算符的列表，请参阅查询运算符。
	对象操作返回的匹配文档的 MongoDB 投影。

响应

请求样本

有效负载
cURL

内容类型

application/json

{"dataSource": "mongodb-atlas",
"database": "todo",
"collection": "tasks",
"filter": {"text": "Do the dishes"
},
"projection": {"status": 1,
"text": 1
}
}

响应样本

200
400
401

内容类型

application/json

{"document": {"_id": "6193504e1be4ab27791c8133",
"status": "open",
"text": "Do the dishes"
}
}

查找文档

查找多个与查询匹配的文档。

授权：

AccessToken(电子邮件密码) ApiKey自定义 JWT

请求正文模式：
application/json

dataSource 必需	字符串链接的 MongoDB Atlas 数据源的名称。它通常为 `"mongodb-atlas"`，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 必需	字符串指定的数据源中的数据库名称。
集合必需	字符串指定的数据库中的集合名称。
筛选器必需	对象匹配文档的 MongoDB 查询筛选器。有关 Data API 支持的所有查询运算符的列表，请参阅查询运算符。
	对象操作返回的匹配文档的 MongoDB 投影。
sort	对象指示排序的字段名称和方向的 MongoDB 排序表达式。
limit	数字响应中包含的匹配文档的最大数量。
跳过	数字要从响应中忽略的匹配文档的数量。

响应

请求样本

有效负载
cURL

内容类型

application/json

{"dataSource": "mongodb-atlas",
"database": "todo",
"collection": "tasks",
"filter": {"status": "complete"
},
"projection": {"text": 1,
"completedAt": 1
},
"sort": {"completedAt": 1
},
"limit": 10
}

响应样本

200
400
401

内容类型

application/json

{"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"
}
]
}

插入一个文档

将单个文档插入到集合中。

授权：

AccessToken(电子邮件密码) ApiKey自定义 JWT

请求正文模式：
application/json

dataSource 必需	字符串链接的 MongoDB Atlas 数据源的名称。它通常为 `"mongodb-atlas"`，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 必需	字符串指定的数据源中的数据库名称。
集合必需	字符串指定的数据库中的集合名称。
文档必需	对象要插入到集合中的文档。

响应

请求样本

有效负载
cURL

内容类型

application/json

{"dataSource": "mongodb-atlas",
"database": "todo",
"collection": "tasks",
"document": {"status": "open${{ env.BUNDLED_SPEC_FILEPATH }}",
"text": "Do the dishes"
}
}

响应样本

200
400
401

内容类型

application/json

{"insertedId": "6193504e1be4ab27791c8133"
}

插入文档

将多个文档插入到集合中。

授权：

AccessToken(电子邮件密码) ApiKey自定义 JWT

请求正文模式：
application/json

dataSource 必需	字符串链接的 MongoDB Atlas 数据源的名称。它通常为 `"mongodb-atlas"`，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 必需	字符串指定的数据源中的数据库名称。
集合必需	字符串指定的数据库中的集合名称。
文档必需	数组对象要插入到集合中的文档列表。

响应

请求样本

有效负载
cURL

内容类型

application/json

{"dataSource": "mongodb-atlas",
"database": "todo",
"collection": "tasks",
"documents": [{"status": "open",
"text": "Mop the floor"
},
{"status": "open",
"text": "Clean the windows"
}
]
}

响应样本

200
400
401

内容类型

application/json

{"insertedIds": ["61935189ec53247016a623c9",
"61935189ec53247016a623ca"
]
}

更新一个文档

更新集合中的一个文档。

授权：

AccessToken(电子邮件密码) ApiKey自定义 JWT

请求正文模式：
application/json

dataSource 必需	字符串链接的 MongoDB Atlas 数据源的名称。它通常为 `"mongodb-atlas"`，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 必需	字符串指定的数据源中的数据库名称。
集合必需	字符串指定的数据库中的集合名称。
筛选器必需	对象匹配文档的 MongoDB 查询筛选器。有关 Data API 支持的所有查询运算符的列表，请参阅查询运算符。
update 必需	对象要应用于匹配文档的 MongoDB 更新表达式。有关 Data API 支持的所有更新操作符的列表，请参阅更新操作符。
更新插入	布尔默认： false 如果为 `true`，在更新筛选器与任何现有文档都不匹配时，将根据筛选器和指定的更新操作插入新文档。

响应

请求样本

有效负载
cURL

内容类型

application/json

{"dataSource": "mongodb-atlas",
"database": "todo",
"collection": "tasks",
"filter": {"_id": {"$oid": "642f1bb5cee4111898828bf6"
}
},
"update": {"$set": {"status": "complete"
}
},
"upsert": false
}

响应样本

200
400
401

内容类型

application/json

{"matchedCount": 1,
"modifiedCount": 1
}

Update Documents

更新集合中的多个文档。

授权：

AccessToken(电子邮件密码) ApiKey自定义 JWT

请求正文模式：
application/json

dataSource 必需	字符串链接的 MongoDB Atlas 数据源的名称。它通常为 `"mongodb-atlas"`，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 必需	字符串指定的数据源中的数据库名称。
集合必需	字符串指定的数据库中的集合名称。
筛选器必需	对象匹配文档的 MongoDB 查询筛选器。有关 Data API 支持的所有查询运算符的列表，请参阅查询运算符。
update 必需	对象要应用于匹配文档的 MongoDB 更新表达式。有关 Data API 支持的所有更新操作符的列表，请参阅更新操作符。
更新插入	布尔默认： false 如果为 `true`，在更新筛选器与任何现有文档都不匹配时，将根据筛选器和指定的更新操作插入新文档。

响应

请求样本

有效负载
cURL

内容类型

application/json

{"dataSource": "mongodb-atlas",
"database": "todo",
"collection": "tasks",
"filter": {"status": "open"
},
"update": {"$set": {"status": "complete"
}
}
}

响应样本

200
400
401

内容类型

application/json

{"matchedCount": 12,
"modifiedCount": 12
}

删除一个文档

删除一个与查询匹配的文档。

授权：

AccessToken(电子邮件密码) ApiKey自定义 JWT

请求正文模式：
application/json

dataSource 必需	字符串链接的 MongoDB Atlas 数据源的名称。它通常为 `"mongodb-atlas"`，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 必需	字符串指定的数据源中的数据库名称。
集合必需	字符串指定的数据库中的集合名称。
筛选器	对象匹配文档的 MongoDB 查询筛选器。有关 Data API 支持的所有查询运算符的列表，请参阅查询运算符。

响应

请求样本

有效负载
cURL

内容类型

application/json

{"dataSource": "mongodb-atlas",
"database": "todo",
"collection": "tasks",
"filter": {"text": "Do the dishes"
}
}

响应样本

200
400
401

内容类型

application/json

{"deletedCount": 1
}

Delete Documents

删除多个与查询匹配的文档。

授权：

AccessToken(电子邮件密码) ApiKey自定义 JWT

请求正文模式：
application/json

dataSource 必需	字符串链接的 MongoDB Atlas 数据源的名称。它通常为 `"mongodb-atlas"`，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 必需	字符串指定的数据源中的数据库名称。
集合必需	字符串指定的数据库中的集合名称。
筛选器	对象匹配文档的 MongoDB 查询筛选器。有关 Data API 支持的所有查询运算符的列表，请参阅查询运算符。

响应

请求样本

有效负载
cURL

内容类型

application/json

{"dataSource": "mongodb-atlas",
"database": "todo",
"collection": "tasks",
"filter": {"status": "complete"
}
}

响应样本

200
400
401

内容类型

application/json

{"deletedCount": 12
}

聚合文档

运行聚合管道。

授权：

AccessToken(电子邮件密码) ApiKey自定义 JWT

请求正文模式：
application/json

dataSource 必需	字符串链接的 MongoDB Atlas 数据源的名称。它通常为 `"mongodb-atlas"`，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 必需	字符串指定的数据源中的数据库名称。
集合必需	字符串指定的数据库中的集合名称。
管道必需	数组对象聚合阶段数组。

响应

请求样本

有效负载
cURL

内容类型

application/json

[{"$groupBy": {"_id": "$status",
"count": {"$sum": 1
},
"tasks": {"$push": "$text"
}
}
},
{"$sort": {"count": 1
}
}
]

响应样本

200
400
401

内容类型

application/json

[{"$groupBy": {"_id": "$status",
"count": {"$sum": 1
},
"tasks": {"$push": "$text"
}
}
},
{"$sort": {"count": 1
}
}
]

dataSource 必需	字符串链接的 MongoDB Atlas 数据源的名称。它通常为 `"mongodb-atlas"`，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 必需	字符串指定的数据源中的数据库名称。
集合必需	字符串指定的数据库中的集合名称。
筛选器必需	对象匹配文档的 MongoDB 查询筛选器。有关 Data API 支持的所有查询运算符的列表，请参阅查询运算符。
	对象操作返回的匹配文档的 MongoDB 投影。

dataSource 必需	字符串链接的 MongoDB Atlas 数据源的名称。它通常为 `"mongodb-atlas"`，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 必需	字符串指定的数据源中的数据库名称。
集合必需	字符串指定的数据库中的集合名称。
筛选器必需	对象匹配文档的 MongoDB 查询筛选器。有关 Data API 支持的所有查询运算符的列表，请参阅查询运算符。
	对象操作返回的匹配文档的 MongoDB 投影。
sort	对象指示排序的字段名称和方向的 MongoDB 排序表达式。
limit	数字响应中包含的匹配文档的最大数量。
跳过	数字要从响应中忽略的匹配文档的数量。

dataSource 必需	字符串链接的 MongoDB Atlas 数据源的名称。它通常为 `"mongodb-atlas"`，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 必需	字符串指定的数据源中的数据库名称。
集合必需	字符串指定的数据库中的集合名称。
文档必需	对象要插入到集合中的文档。

dataSource 必需	字符串链接的 MongoDB Atlas 数据源的名称。它通常为 `"mongodb-atlas"`，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 必需	字符串指定的数据源中的数据库名称。
集合必需	字符串指定的数据库中的集合名称。
文档必需	数组对象要插入到集合中的文档列表。

dataSource 必需	字符串链接的 MongoDB Atlas 数据源的名称。它通常为 `"mongodb-atlas"`，但如果您在创建数据源时选择了不同的名称，则在应用程序中可能具有不同的名称。
database 必需	字符串指定的数据源中的数据库名称。
集合必需	字符串指定的数据库中的集合名称。
筛选器必需	对象匹配文档的 MongoDB 查询筛选器。有关 Data API 支持的所有查询运算符的列表，请参阅查询运算符。
update 必需	对象要应用于匹配文档的 MongoDB 更新表达式。有关 Data API 支持的所有更新操作符的列表，请参阅更新操作符。
更新插入	布尔默认： false 如果为 `true`，在更新筛选器与任何现有文档都不匹配时，将根据筛选器和指定的更新操作插入新文档。

MongoDB Atlas Data API (v1)

设置数据 API

对请求进行身份验证

查找一个文档

授权：

请求正文模式： application/jsonapplication/ejsonapplication/json

响应

请求样本

响应样本

查找文档

授权：

请求正文模式： application/jsonapplication/ejsonapplication/json

响应

请求样本

响应样本

插入一个文档

授权：

请求正文模式： application/jsonapplication/ejsonapplication/json

响应

请求样本

响应样本

插入文档

授权：

请求正文模式： application/jsonapplication/ejsonapplication/json

响应

请求样本

响应样本

更新一个文档

授权：

请求正文模式： application/jsonapplication/ejsonapplication/json

响应

请求样本

响应样本

Update Documents

授权：

请求正文模式： application/jsonapplication/ejsonapplication/json

响应

请求样本

响应样本

删除一个文档

授权：

请求正文模式： application/jsonapplication/ejsonapplication/json

响应

请求样本

响应样本

Delete Documents

授权：

请求正文模式： application/jsonapplication/ejsonapplication/json

响应

请求样本

响应样本

聚合文档

授权：

请求正文模式： application/jsonapplication/ejsonapplication/json

响应

请求样本

响应样本

请求正文模式：
application/json

请求正文模式：
application/json

请求正文模式：
application/json

请求正文模式：
application/json

请求正文模式：
application/json

请求正文模式：
application/json

请求正文模式：
application/json

请求正文模式：
application/json

请求正文模式：
application/json