通过 MongoDB,使用点并点击的方式创建 Web API
在我们的CData软件实践中,您可以轻松地使用鼠标点击来创建从MongoDB到WebAPI的连接。
使用CData产品
- CData API Server
MongoDB环境配置
事先按照以下步骤获取MongoDB账户。
使用mLab搭建MongoDB环境的方法以及导入示例数据的方式。
安装CData API Server
从以下网站下载CData API Server的构建版本。
- CData API Server
运行下载的”setup.exe”文件。启动安装程序如下所示,请确保查阅许可协议后,按照默认设置继续安装,直至完成。
在途中,将显示设置APIServer管理员密码的页面,请将设置的密码备份保存。
完成安装后,Windows右下角的通知区域会出现一个蓝色云图标的CData APIServer应用程序,其中嵌入了Web服务器,将会启动。
另外,浏览器将启动并打开CData APIServer管理控制台的登录页面。
安装CData ADO.NET Provider for MongoDB
安装CData ADO.NET Provider for MongoDB,这是一个用于连接APIServer和MongoDB的连接库。
首先,您需要在Windows右下角的通知区域找到蓝色云图标。然后,以右键点击该图标,并选择“停止服务器”以停止CDataAPIServer。
确认服务器已停止后,从以下网站下载CData ADO.NET Provider for MongoDB的构建版本。
- CData ADO.NET Provider for MongoDB
我們來運行下載的 “setup.exe” 文件。一旦安裝程序啟動,請確認許可協議並按照默認設置進行安裝,直至完成。
完成安装后,请再次右键单击位于Windows右下方的通知区域的蓝色云图标并选择”启动服务器”。启动后,双击蓝色云图标即可打开浏览器,显示CData APIServer的管理控制台登录页面。
连接到MongoDB的配置
在CData APIServer的管理控制台的登录界面上,输入用户名”admin”和在安装程序中设置的密码,然后点击”登录”按钮。成功登录后,将显示”信息”页面。如果显示了未经授权的许可证消息,点击”激活30天试用版”按钮,在弹出的对话框中填写”名称:”和”E-mail”,然后确认”条款和条件”,最后点击”激活试用版”按钮。
请刷新浏览器,确认能够显示产品的30日试用版(30天试用版本-剩余30天)。
打开「设置>连接」选项卡, 点击「+添加连接…」按钮。
选择”Databases”中的MongoDB。
设置MongoDB的连接信息。设置后,点击“测试连接”按钮,如果显示“连接成功”,则表示已成功从CDataAPIServer连接到MongoDB。使用“保存更改”按钮保存连接信息。
确认连接信息已保存并在Connections中显示MongoDB连接信息。
创建API终点
打开「设置」>「资源」选项卡,然后点击「添加资源…」按钮。
选择在先前步骤中创建的MongoDB数据连接设置,然后点击“下一步”按钮。
在MongoDB中,表格和视图将显示为一个列表。在这次操作中,选择[Sample]表格,然后点击”下一步”按钮。
[Example] 列出了表中的项目列表。默认情况下,”操作:”下方的所有复选框都被选中,并允许执行GET(SELECT)、POST(INSERT)、PUT(UPDATE)和DELETE(DELETE)等所有CRUD操作。此外,访问用户也被设定为”*(全用户)”。现在,我们将直接点击”保存”按钮。
回到资源列表页面,确认已添加了”CData_(数据库名)_Sample”资源。
创建一个API访问用户
请点击进入「设置 > 用户」选项卡,并点击用户下的「添加」按钮。
会显示一个”添加用户”对话框。您可以输入用户名(可选),并勾选每个用户的操作权限,包括GET(查询)、POST(插入)、PUT(更新)和DELETE(删除),然后点击”保存更改”按钮。您还可以在此界面上设置一定时间内的API访问次数限制(RateLimit)以及并发连接数限制。
请返回用户列表页面,确认用户已经添加并生成了Auth令牌。请记住用户名称和Auth令牌,因为在进行API访问时会需要用到。
访问WebAPI
让我们尝试访问创建的WebAPI。打开“API”选项卡,将打开API参考文档。
在左侧将显示资源列表,请选择通过上述步骤添加的资源“/api.rsc/(数据库名称)_Sample”。
在右侧显示HTTP方法、各种属性和附加格式的信息。由于GET方法可以从Web浏览器发送请求,因此可以在浏览器的新标签页或窗口中输入并打开URL“http://localhost:8387/api.rsc/CData_(数据库名称)_Sample/”。如果浏览器以JSON格式显示MongoDB中Sample表的数据作为响应,则表示成功。
如果您从与管理控制台相同的网页浏览器访问,不需要进行用户认证。但是,如果您使用一个新的浏览器进行访问,则需要进行认证。请在用户名字段中输入使用上述步骤创建的API访问用户名,并在密码字段中输入Auth令牌。
我成功使用MongoDB创建了Web API,并能够从Web浏览器访问。