[Hướng dẫn] Quản lý Phiên bản API của bạn bằng Postman

Việc duy trì các phiên bản API nhất quán và được tài liệu hóa tốt là rất quan trọng cho sự phát triển API hiệu quả. Tuy nhiên, việc quản lý nhiều phiên bản và hợp tác hiệu quả trong nhóm có thể là một công việc phức tạp.

💡

Apidog là một giải pháp tất cả trong một cho tất cả các vấn đề liên quan đến API. Tương tự như Postman, bạn có thể sử dụng tính năng Lịch sử của Apidog để xem tất cả các thay đổi trong quá khứ, cho phép bạn quan sát hoặc quay trở lại bất kỳ thay đổi nào đã thực hiện trước đây.

Để tìm hiểu thêm về khả năng của Apidog, hãy nhấp vào nút bên dưới! 👇

button

Hướng dẫn này khám phá các chức năng của hệ thống kiểm soát phiên bản tích hợp của Postman, giúp bạn quản lý các phiên bản API một cách hiệu quả, tối ưu hóa sự hợp tác và duy trì một lịch sử rõ ràng về các thay đổi. Bằng cách tận dụng các tính năng này, bạn có thể đảm bảo quy trình phát triển API được tổ chức tốt và hiệu quả hơn.

Postman là gì?

Postman hoạt động như một trung tâm chính cho việc phát triển API, giúp đơn giản hóa quy trình cho lập trình viên. Bộ tính năng toàn diện của nó bao gồm thiết kế, thử nghiệm và khả năng tài liệu. Việc hợp nhất các chức năng này đã củng cố vị thế của Postman như một công cụ ưu tiên cho các nhà phát triển thực hiện nhiều loại dự án liên quan đến API.

Kiểm soát phiên bản của Postman là gì?

Kiểm soát phiên bản của Postman cho phép bạn và nhóm tạo ra và sửa đổi một API một cách hợp tác. Hệ thống kiểm soát phiên bản chuyên về việc quản lý:

Bộ sưu tập API: Các bộ sưu tập xác định các yêu cầu API của bạn, bao gồm URL, tham số, tiêu đề và nội dung body.

Môi trường API: Các biến môi trường API được lưu trữ trong hệ thống kiểm soát phiên bản của Postman để sử dụng trong các bộ sưu tập của bạn. Điều này cho phép người dùng dễ dàng chuyển đổi giữa môi trường phát triển, thử nghiệm và sản xuất.

API Mocks: Các mô phỏng API giả lập phản hồi máy chủ cho các điểm cuối API, làm cho chúng hữu ích cho mục đích thử nghiệm.

Chức năng kiểm soát phiên bản của Postman

Kiểm soát phiên bản của Postman cung cấp nhiều tính năng cho các nhà phát triển tối ưu hóa quy trình phát triển API, chẳng hạn như:

Theo dõi các thay đổi

Duy trì một lịch sử rõ ràng về các thay đổi cho bộ sưu tập, môi trường và mô phỏng của bạn.
Xác định ai đã thực hiện các thay đổi cụ thể và chỉ ra thời gian chính xác để cải thiện trách nhiệm và sự hợp tác.

Phân nhánh và Gộp

Lấy cảm hứng từ quy trình công việc của Git, Postman cho phép bạn tạo một bản sao (nhánh) của một phần tử (bộ sưu tập, môi trường, mô phỏng) để làm việc độc lập.
Khi các chỉnh sửa hoàn tất, dễ dàng gộp các thay đổi của bạn vào phiên bản chính, tối ưu hóa sự hợp tác và tích hợp các đóng góp cá nhân.

Yêu cầu kéo

Khuyến khích phát triển minh bạch bằng cách cho phép các thành viên trong nhóm xem xét các thay đổi được đề xuất trước khi gộp chúng vào phiên bản chính.
Quy trình hợp tác này giúp xác định và giải quyết các xung đột tiềm năng trước khi chúng gây rối cho quy trình làm việc.

Lịch sử phiên bản

Truy cập các phiên bản trước của bộ sưu tập, môi trường và mô phỏng của bạn.
Ghi chép lịch sử này cho phép bạn quay lại các phiên bản trước nếu cần, cung cấp một mạng lưới an toàn trong trường hợp có những thay đổi không mong muốn.

Tích hợp với các hệ thống kiểm soát phiên bản bên ngoài

Khi hệ thống tích hợp sẵn của Postman xuất sắc trong việc quản lý các đối tượng API, nó cũng có thể tích hợp với các hệ thống bên ngoài như Git.
Sự đồng bộ này cho phép bạn quản lý các thay đổi đối với các bộ sưu tập Postman của bạn cùng với mã nguồn trong một kho lưu trữ duy nhất, thúc đẩy một nguồn thông tin thống nhất cho các định nghĩa API của bạn.

Mẫu trình diễn kiểm soát phiên bản API của Postman

Mẫu trình diễn kiểm soát phiên bản API trên Postman này sẽ bao gồm việc sử dụng một kho lưu trữ Git.

Tạo một API trong Postman

Tạo một yêu cầu mới bằng cách nhấp vào nút New ở góc trên bên trái của cửa sổ Postman. Chọn HTTP Request để tạo một yêu cầu mới, như hình ảnh ở trên.

Nhập phương thức và chi tiết API

Bao gồm các chi tiết của yêu cầu API mà bạn muốn tạo. Nó phải bao gồm các thành phần như URL, phương thức HTTP và các tham số bổ sung mà API sẽ yêu cầu.

Chọn cài đặt nhóm

Tiếp tục bằng cách nhấp vào Team Settings.

Chọn ứng dụng đã cài đặt

Bạn sẽ được chuyển đến một trang web để cấu hình thêm. Trên trang này, tìm Installed apps nằm trong danh sách dọc bên trái. Nếu bạn có GitHub Enterprise Server hoặc GitLab Self-Managed, thì các ứng dụng này sẽ xuất hiện trên màn hình này.

Nhập URL miền của kho lưu trữ GitHub

Nhập URL miền của kho lưu trữ GitHub của bạn, trông giống như:

GitHub Enterprise Server: https://my-github-server.example.com

GitLab Self-Managed: https://gitlab.example.com

Tạo ứng dụng OAuth

Tuân theo nhà cung cấp Git mà bạn có, theo hướng dẫn để tạo một ứng dụng OAuth.

URL trang chủ - Nhập URL trang chủ của Postman: https://www.postman.com
URL callback xác thực hoặc URI chuyển hướng - Nhập URL callback xác thực được cung cấp trong Postman: https://integration-oauth.pstmn.io/v1/api-git-callback.html
Phạm vi - Đảm bảo chọn các phạm vi thích hợp khi tạo ứng dụng OAuth để cho phép Postman đọc và viết vào kho lưu trữ của bạn. Đối với GitHub, chọn các phạm vi repo và user. Đối với GitLab Self-Managed, chọn phạm vi api.

Ngay khi bạn có ứng dụng OAuth, hãy sao chép Client ID và Secret của nó để nhập vào Postman.

Hợp tác đơn giản, rõ ràng với Apidog

Apidog là một nền tảng phát triển API mạnh mẽ có thể thay thế tuyệt vời cho Postman. Với khả năng hợp tác đáng tin cậy và một hệ thống kiểm soát phiên bản riêng biệt tích hợp trong Apidog, người dùng có thể làm việc cùng nhau trong một nhóm để phát triển API một cách chuyên nghiệp và hiệu quả.

button

Xây dựng APIs với Apidog

Với Apidog, bạn và nhóm của bạn có thể tạo APIs chỉ trong vài cú nhấp chuột.

Để bắt đầu, nhấn nút New API, như hình ảnh ở trên.

Tiếp tục bằng cách xác định các đặc điểm khác nhau của API. Phần này cho phép bạn:

Xác định phương thức HTTP: Chọn phương thức HTTP phù hợp (GET, POST, PUT hoặc DELETE) để xác định hoạt động mong muốn của máy chủ.
Xác định URL điểm cuối API: Chỉ định URL điểm cuối API cụ thể (hoặc địa chỉ API) mà tạo điều kiện cho sự tương tác giữa máy khách và máy chủ.
Thêm Tham số (Tùy chọn): Bao gồm một hoặc nhiều tham số để được bao gồm động trong URL API, cho phép các yêu cầu tùy chỉnh.
Cung cấp mô tả chức năng: Viết một mô tả ngắn gọn giải thích chức năng dự kiến của API.

Kiểm soát phiên bản với Apidog

Dưới phần Thiết kế của API của bạn, nhấn vào biểu tượng hình vuông nhỏ như được hiển thị trong hình ảnh trên. Điều này sẽ dẫn bạn đến phần nhật ký thay đổi của API của bạn.

Trong danh sách này, bạn có thể chọn cập nhật nào bạn muốn xem.

Cuối cùng, bạn có thể quan sát các thay đổi được thực hiện từ một phiên bản của API sang một phiên bản khác. Bạn có thể thấy khi nào thay đổi đã được thực hiện, và ai là người đã thực hiện thay đổi. Nếu trong bất kỳ trường hợp nào cần phiên bản cũ hơn của API, người dùng cũng sẽ có tùy chọn quay về một phiên bản cũ được chọn.

button

Kết luận

Việc sử dụng hiệu quả các chức năng kiểm soát phiên bản của Postman cho phép các nhà phát triển tạo ra một môi trường phát triển API tổ chức và hợp tác hơn. Hướng dẫn này đã trang bị cho bạn kiến thức để theo dõi các thay đổi, tạo điều kiện cho sự hợp tác trong nhóm thông qua các tính năng như phân nhánh và gộp, và duy trì một lịch sử rõ ràng về các phiên bản API.

Hãy nhớ rằng, một chiến lược kiểm soát phiên bản được xác định rõ ràng là rất cần thiết để tối ưu hóa quy trình làm việc của bạn, ngăn ngừa xung đột và đảm bảo sự phát triển suôn sẻ của các API. Hãy áp dụng các tính năng tích hợp sẵn của Postman và khám phá khả năng tích hợp với các hệ thống bên ngoài để thiết lập một phương pháp kiểm soát phiên bản giúp nâng cao đội ngũ phát triển của bạn.