Ngày 10 tháng 11 năm 2021 · 6 phút· 6 mins
Đây là một bài đăng của khách được viết bởi Lauren Schaefer, nhà phát triển nhân viên ủng hộ tại MongoDB.
MongoDB Atlas là một dịch vụ cơ sở dữ liệu tài liệu đa đám mây giúp làm việc với dữ liệu dễ dàng. Atlas có giao diện web cho phép bạn định cấu hình cơ sở dữ liệu, biểu đồ, hồ dữ liệu và dịch vụ ứng dụng của bạn với một vài cú nhấp chuột của chuột.
Atlas cũng có API quản trị mà bạn có thể sử dụng để tương tác lập trình với dịch vụ cơ sở dữ liệu. Ví dụ: bạn có thể sử dụng API ATLAS Quản trị để tạo triển khai cơ sở dữ liệu, thêm người dùng vào các triển khai đó, theo dõi các triển khai đó và hơn thế nữa. Các cuộc gọi API này đặc biệt hữu ích cho những người tạo đường ống CI/CD cũng như các chuyên gia CNTT, những người tạo ra các cổng phát triển tự phục vụ.
Postman là một nền tảng API phổ biến giúp làm việc với API dễ dàng. Kiến trúc sư giải pháp cao cấp MongoDB Cassiano Ziegler Bein đã tạo ra một bộ sưu tập người đưa thư chứa yêu cầu cho mọi điểm cuối trong API của Quản trị Atlas. Bộ sưu tập này là một bổ sung tuyệt vời cho tài liệu MongoDB chi tiết trên API của Quản trị Atlas.
Trong bài đăng trên blog này, tôi sẽ hướng dẫn bạn cách truy cập và sử dụng Bộ sưu tập Postman Cassiano, vì vậy bạn có thể nhanh chóng học cách sử dụng API ATLAS Managemation.
Thiết lập Atlas
Điều đầu tiên bạn cần làm là tạo triển khai cơ sở dữ liệu ở Atlas. Lưu ý rằng việc triển khai cơ sở dữ liệu miễn phí là đủ cho hướng dẫn này. Nếu bạn muốn chạy tất cả các API trong bộ sưu tập, bạn sẽ cần nâng cấp lên triển khai trả phí.
- Điều hướng đến Atlas và sau đó đăng ký hoặc xác thực.
- Tạo một tổ chức Atlas. Tổ chức này là nơi bạn sẽ lưu trữ các dự án của bạn.
- Tạo một dự án trong tổ chức bạn vừa tạo. Dự án là nơi bạn sẽ lưu trữ triển khai cơ sở dữ liệu của mình.
- Tạo một triển khai cơ sở dữ liệu trong dự án bạn vừa tạo. Triển khai cơ sở dữ liệu là nơi cơ sở dữ liệu của bạn sẽ được lưu trữ.
- Điều hướng đến trang Cài đặt dự án cho dự án của bạn. Lưu trữ ID dự án ở một nơi an toàn. Bạn sẽ sử dụng nó sau này trong Postman.Project ID in a safe place. You will use it later in Postman.
Bây giờ bạn đã triển khai cơ sở dữ liệu, hãy để tạo khóa API. Bạn sẽ sử dụng khóa API này sau này trong Postman để xác thực với Atlas.
- Tạo khóa API trong tổ chức bạn đã tạo trong phần trước. Cấp khóa API cho phép chủ sở hữu tổ chức.Organization Owner permission.
- Thêm địa chỉ IP hiện tại của bạn vào danh sách truy cập API cho khóa API này.
- Lưu trữ khóa công khai API và khóa riêng ở một nơi an toàn. Bạn sẽ sử dụng chúng sau này trong Postman.
Thiết lập người đưa thư
Trong phần này, bạn sẽ hoàn thành hai nhiệm vụ: Fork A bản sao của Bộ sưu tập Postman với tất cả các cuộc gọi API của Quản trị Atlas và định cấu hình ủy quyền cho tất cả các yêu cầu trong bộ sưu tập.
Lưu ý: Các bước dưới đây sẽ sử dụng giao diện web Postman, nhưng bạn có thể chọn sử dụng ứng dụng máy tính để bàn Postman nếu bạn thích.: The steps below will use the Postman web interface, but you can choose to use the Postman desktop application if you’d like.
- Fork Bộ sưu tập Atlas MongoDB cho một trong những không gian làm việc của người đưa thư của bạn bằng cách sử dụng nút này: một bản sao của Bộ sưu tập MongoDB Atlas và môi trường Atlas sẽ được thêm vào không gian làm việc của bạn. Bạn sẽ được chuyển hướng đến không gian làm việc của bạn.
A copy of the MongoDB Atlas collection and the Atlas environment will be added to your workspace. You will be redirected to your workspace. - Mở Bộ sưu tập MongoDB Atlas và sau đó là khung ủy quyền.MongoDB Atlas collection and then the Authorization pane.
- Đảm bảo loại được đặt thành Digest Auth.Type is set to Digest Auth.
- Nhập khóa công khai API API trong trường tên người dùng.Username field.
- Nhập khóa riêng API API trong trường Mật khẩu.Password field.
- Lưu bộ sưu tập.
Các yêu cầu trong bộ sưu tập được nhóm lại với nhau bởi tài nguyên mà chúng tương tác. Mỗi tài nguyên có thư mục riêng. Ví dụ, bạn sẽ tìm thấy các thư mục cho các cụm, dự án và cảnh báo.
Một số yêu cầu trong bộ sưu tập sử dụng các biến. Các biến cho phép bạn định cấu hình các yêu cầu cho dự án ATLAS của bạn. Môi trường Postman là nơi lưu trữ các biến mà các yêu cầu có thể sử dụng.
Khi bạn lấy bộ sưu tập MongoDB Atlas, một bản sao của môi trường Atlas cũng được thêm vào không gian làm việc của bạn. Trong phần này, bạn sẽ cập nhật một biến được lưu trữ trong môi trường Atlas.
- Mở môi trường Atlas để chỉnh sửa.
- Cập nhật giá trị hiện tại của biến dự án vào ID dự án Atlas mà bạn đã truy xuất trong phần trước.ProjectID variable to the Atlas project ID you retrieved in an earlier section.
- Chọn môi trường Atlas làm môi trường hoạt động của bạn.
Đưa ra một yêu cầu
Bây giờ bạn đã cấu hình Atlas và Postman, bạn đã sẵn sàng thực hiện yêu cầu đầu tiên của mình.
- Trong bộ sưu tập Atlas MongoDB, mở rộng thư mục cụm.MongoDB Atlas collection, expand the Clusters folder.
- Chọn yêu cầu Get All Clusters. Xem tài liệu MongoDB để biết chi tiết về điểm cuối của Get All Clusters.Get All Clusters request. See the MongoDB documentation for details on the Get All Clusters endpoint.
- Nhấp vào Gửi để chạy yêu cầu. Điểm cuối API trả về thông tin về các cụm trong dự án của bạn.Send to run the request. The API endpoint returns information about the clusters in your project.
Lưu ý: Nếu bạn đang chạy yêu cầu này trong giao diện web Postman thay vì ứng dụng Desktop Postman, API có thể trả về lỗi 403 cho biết địa chỉ IP không được phép truy cập tài nguyên. Điều này là do yêu cầu đến từ máy chủ Postman thay vì máy cục bộ của bạn. Trong quá trình phát triển và thử nghiệm, bạn có thể chọn thêm địa chỉ IP của máy chủ Postman vào danh sách truy cập khóa API của bạn.: If you are running this request in the Postman web interface instead of the Postman desktop application, the API may return a 403 error indicating that an IP address is not allowed to access the resource. This is because the request is coming from the Postman server instead of your local machine. During development and testing, you may choose to add the Postman server’s IP address to your API key’s access list.
Bạn làm được rồi! Bạn đã thực hiện yêu cầu đầu tiên của bạn cho API ATLAS API từ Postman.
Bộ sưu tập Atlas MongoDB chứa các yêu cầu cho nhiều điểm cuối. Dành một chút thời gian để khám phá các yêu cầu trong bộ sưu tập và thử chúng.
Lưu ý: Nhận yêu cầu Truy xuất thông tin từ Atlas. Các loại yêu cầu khác như Post, Patch và Delete sẽ thay đổi tài nguyên Atlas của bạn.: GET requests retrieve information from Atlas. Other request types like POST, PATCH, and DELETE will make changes to your Atlas resources.
Bản tóm tắt
API Quản trị Atlas MongoDB cung cấp cho bạn một cách lập trình để quản lý dữ liệu và cấu hình của bạn trong nền tảng dữ liệu đám mây Atlas. Bộ sưu tập MongoDB Atlas Postman đơn giản hóa việc bắt đầu và khám phá API ATLAS ASPORATION.
Bạn muốn xem bộ sưu tập Atlas Postman MongoDB Atlas? Tham gia với chúng tôi để phát trực tiếp sắp tới của chúng tôi:
- Học tập với Luce - Tự động hóa tự động hóa trên MongoDB ATLAS [ATLAS API & Postman] vào ngày 13 tháng 1 năm 2022: có Luce Carter [nhà phát triển người ủng hộ tại MongoDB], Cassiano Ziegler Bein [Kiến trúc sư giải pháp tại MongoDB] và Meenakshi Dhanani tại Postman].
Nếu bạn có bất kỳ câu hỏi nào về API ATLAS API hoặc cách sử dụng bộ sưu tập này, hãy tham gia với chúng tôi trong cộng đồng MongoDB. Nhân viên MongoDB và các thành viên trong cộng đồng của chúng tôi có mặt mỗi ngày để trả lời các câu hỏi. Tôi hy vọng sẽ gặp bạn ở đó!
Đánh giá kỹ thuật của Arlemi Turpault.