URL cơ sở trong Apidog cho phép bạn trích xuất phần lặp lại của các địa chỉ điểm cuối để quản lý thống nhất.
Ví dụ, nếu điểm cuối của bạn là https://api.example.com/v1/users, bạn có thể đặt https://api.example.com/v1 làm URL cơ sở. Sau đó, trong định nghĩa điểm cuối của mình, bạn chỉ cần viết /users.
Khi gửi yêu cầu, Apidog sẽ tự động nối URL cơ sở và đường dẫn điểm cuối để tạo thành địa chỉ yêu cầu hoàn chỉnh. Lợi ích là nếu địa chỉ máy chủ thay đổi, bạn chỉ cần cập nhật URL cơ sở—không cần sửa đổi từng điểm cuối riêng lẻ.
Các bước để thiết lập URL cơ sở
Mở dự án Apidog của bạn và tìm "Quản lý môi trường" ở góc trên bên phải. Apidog sẽ tạo một số môi trường phổ biến theo mặc định, chẳng hạn như phát triển, thử nghiệm và sản xuất. Bạn có thể sử dụng các cài đặt sẵn này hoặc tạo môi trường mới nếu cần.
Sau khi chọn một môi trường, bạn sẽ thấy ô nhập "URL cơ sở". Nhập địa chỉ cơ sở bắt đầu bằng giao thức (http:// hoặc https://), chẳng hạn như https://test.server.com, hoặc bao gồm số phiên bản như https://api.example.com/v1.
Đảm bảo **_không thêm dấu gạch chéo cuối cùng_**. Theo đặc tả OpenAPI, URL cơ sở **không nên** kết thúc bằng `/`, trong khi đường dẫn điểm cuối **nên** bắt đầu bằng `/`.
Chúng tôi khuyên bạn nên tuân thủ đặc tả OpenAPI để có khả năng tương thích tốt hơn và trải nghiệm tính năng đầy đủ hơn trong Apidog.
Sử dụng URL cơ sở trong các điểm cuối
Bây giờ, khi bạn tạo một điểm cuối mới, bạn chỉ cần nhập đường dẫn điểm cuối vào trường URL. Ví dụ, để kiểm tra điểm cuối danh sách người dùng, chỉ cần nhập /users, và Apidog sẽ tự động kết hợp nó thành URL yêu cầu hoàn chỉnh https://api.example.com/v1/users.
Nếu đường dẫn điểm cuối của bạn bao gồm nhiều cấp, như /users/123/profile, bạn có thể làm theo phương pháp tương tự—Apidog sẽ tự động kết hợp URL cơ sở với đường dẫn của bạn để tạo thành URL yêu cầu hoàn chỉnh.
Lưu ý: Nếu bạn nhập một địa chỉ đầy đủ (bắt đầu bằng http:// hoặc https://) vào URL điểm cuối, URL cơ sở **sẽ không được sử dụng**. Apidog sẽ ưu tiên địa chỉ đầy đủ mà bạn cung cấp.
Quản lý URL cơ sở trên nhiều môi trường
Hầu hết các dự án đều có nhiều môi trường (phát triển, thử nghiệm, sản xuất), mỗi môi trường có một địa chỉ máy chủ khác nhau. Bạn có thể đặt một URL cơ sở khác nhau cho mỗi môi trường.
Ví dụ:
- Phát triển:
https://dev-api.example.com/v1 - Thử nghiệm:
https://test-api.example.com/v1 - Sản xuất:
https://api.example.com/v1
Khi bạn chuyển đổi môi trường từ góc trên bên phải, tất cả các điểm cuối sẽ tự động sử dụng địa chỉ máy chủ cho môi trường đã chọn.
Bạn cũng có thể chọn môi trường trực tiếp trong thanh địa chỉ điểm cuối, nơi URL cơ sở mặc định cho mỗi môi trường được hiển thị. Điều này hoạt động tương tự như việc chuyển đổi môi trường trong bảng điều khiển "Quản lý môi trường".
Lưu ý: Nếu một môi trường có nhiều URL cơ sở, chỉ URL mặc định mới xuất hiện trong thanh địa chỉ. Để sử dụng URL cơ sở không mặc định cho các điểm cuối cụ thể, bạn sẽ cần đặt thủ công trong điểm cuối hoặc quản lý thông qua **các module**.
Thiết lập nhiều URL cơ sở này phổ biến trong kiến trúc microservice, nơi các điểm cuối khác nhau cần sử dụng các địa chỉ dịch vụ khác nhau.
Quản lý URL cơ sở trong Microservice
Nếu dự án của bạn sử dụng kiến trúc microservice và không phải tất cả các điểm cuối đều chia sẻ cùng một URL cơ sở, bạn có hai cách để quản lý URL cơ sở trong Apidog.
Chỉ định thủ công URL cơ sở trong một Module
Bạn có thể nhóm các điểm cuối từ các dịch vụ khác nhau vào một module duy nhất và gán các URL cơ sở khác nhau cho các thư mục cụ thể hoặc các điểm cuối riêng lẻ. Thiết lập này linh hoạt và hoạt động tốt cho các nhóm thích quản lý tập trung.
Ví dụ, bạn có thể cấu hình một module với nhiều URL cơ sở cho các dịch vụ khác nhau.
Sau đó, gán URL cơ sở của **"Dịch vụ Người dùng"** cho thư mục _user_ và URL cơ sở của **"Dịch vụ Đơn hàng"** cho thư mục _order_. Tất cả các điểm cuối trong mỗi thư mục sẽ tự động sử dụng URL cơ sở tương ứng.
Nếu bạn không muốn cấu hình theo thư mục, bạn cũng có thể đặt URL cơ sở cho từng điểm cuối. Chỉ cần mở trang "Chỉnh sửa" của điểm cuối và chọn URL cơ sở mong muốn từ menu thả xuống.
Tuy nhiên, khi số lượng dịch vụ tăng lên, việc quản lý URL cơ sở theo cách này có thể trở nên tẻ nhạt và khó duy trì hơn. Nó có thể hoạt động tốt cho các dự án nhỏ hơn, nhưng các dự án lớn hơn có thể nhanh chóng trở nên khó quản lý.
Để có khả năng mở rộng và rõ ràng hơn, chúng tôi khuyên dùng một cách tiếp cận có cấu trúc hơn:
**tách mỗi dịch vụ thành module riêng và đặt URL cơ sở ở cấp độ module**. Điều này giúp dự án của bạn được tổ chức và dễ bảo trì hơn nhiều.
Tổ chức dịch vụ theo Module (Khuyên dùng)
Tạo một module riêng cho mỗi dịch vụ và cấu hình URL cơ sở của nó trong "Quản lý môi trường" cho mỗi môi trường. Cách tiếp cận này có tổ chức hơn và lý tưởng cho việc hợp tác nhóm cũng như bảo trì lâu dài.
Ví dụ, bạn có thể tạo các module riêng biệt cho **Dịch vụ Người dùng**, **Dịch vụ Đơn hàng** và **Dịch vụ Sản phẩm**, mỗi module được liên kết với tệp đặc tả Swagger hoặc OpenAPI riêng của nó.
Sau khi các module được thiết lập, hãy truy cập trang "Quản lý môi trường", nơi bạn sẽ thấy các cài đặt URL cơ sở được nhóm gọn gàng theo module.
Mỗi môi trường chia sẻ cùng cấu trúc module, nhưng URL cơ sở cho mỗi module có thể khác nhau tùy theo môi trường. Điều này cho phép bạn gán các URL cơ sở cụ thể cho mọi module trong mỗi môi trường. Ví dụ:
| Môi trường | Dịch vụ Sản phẩm | Dịch vụ Người dùng | Dịch vụ Đơn hàng |
|---|---|---|---|
| Sản xuất | https://product.example.com | https://user.example.com | https://order.example.com |
| Thử nghiệm | http://192.168.1.10:8080 | http://192.168.1.11:8080 | http://192.168.1.12:8080 |
| Phát triển | http://localhost:3000 | http://localhost:3001 | http://localhost:3002 |
Với thiết lập này, bất cứ khi nào bạn tạo một điểm cuối mới trong một module, nó sẽ tự động sử dụng URL cơ sở chính xác cho môi trường hiện tại—không cần chọn thủ công. Ví dụ:
- Trong "Module Dịch vụ Người dùng & Môi trường Sản xuất", URL cơ sở mặc định là
https://user.example.com. - Trong "Module Dịch vụ Đơn hàng & Môi trường Thử nghiệm", đó là
http://192.168.1.12:8080.
Hãy coi cặp "Module + Môi trường" như một hệ tọa độ xác định chính xác URL yêu cầu. Miễn là các module và môi trường của bạn được tổ chức đúng cách, Apidog sẽ tự động chọn URL cơ sở chính xác cho mỗi yêu cầu.
Bạn sẽ không phải tự hỏi, _"Điểm cuối này đang sử dụng địa chỉ nào?"_—chỉ cần chọn module và môi trường phù hợp, và Apidog sẽ xử lý phần còn lại.Hỏi ChatGPT
Mẹo thực tế khi sử dụng URL cơ sở
- Nếu API của bạn bao gồm số phiên bản, hãy thêm trực tiếp vào URL cơ sở—ví dụ:
https://api.example.com/v2. Bằng cách này, khi bạn nâng cấp phiên bản API, bạn chỉ cần cập nhật URL cơ sở, chứ không phải từng điểm cuối. - Đối với các trường hợp đặc biệt, như gọi dịch vụ của bên thứ ba, bạn có thể nhập URL đầy đủ trực tiếp vào điểm cuối. Điều này sẽ tự động ghi đè URL cơ sở mặc định.
Kết luận
Quản lý URL cơ sở hiệu quả là chìa khóa để giữ cho các dự án API của bạn gọn gàng, có khả năng mở rộng và dễ bảo trì—đặc biệt khi chúng ngày càng phức tạp. Dù bạn đang làm việc với một dự án dịch vụ đơn giản hay một kiến trúc microservice lớn, Apidog đều cung cấp các tùy chọn linh hoạt phù hợp với quy trình làm việc của bạn.
Bằng cách tổ chức các dịch vụ của bạn thành các module và cấu hình URL cơ sở cho mỗi môi trường, bạn đảm bảo rằng mỗi điểm cuối luôn trỏ đến máy chủ chính xác—mà không cần công sức thủ công. Với các cài đặt mặc định thông minh, chuyển đổi môi trường và thiết kế module, Apidog đơn giản hóa quy trình và loại bỏ phỏng đoán.