Quản lý thông số kỹ thuật

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X.
thông tin

Apigee Edge cung cấp cho bạn một nơi để lưu trữ Quy cách OpenAPI. Quản lý OpenAPI Specification, như mô tả trong các phần sau.

Để biết thêm thông tin về Thông số kỹ thuật OpenAPI, hãy xem bài viết Thông số kỹ thuật OpenAPI là gì?

Khám phá danh sách thông số kỹ thuật

Cách truy cập vào danh sách thông số kỹ thuật:

  1. Đăng nhập vào apigee.com/edge.
  2. Chọn tổ chức.
  3. Chọn Phát triển > Thông số kỹ thuật trong trình đơn điều hướng bên.

Danh sách các quy cách và thư mục hiện tại sẽ xuất hiện.

Danh sách quy cách

Như được làm nổi bật trong hình trước, trong danh sách thông số kỹ thuật, bạn có thể:

Tạo một OpenAPI Specification mới

Cách tạo một OpenAPI Specification mới:

  1. Nhấp vào Phát triển > Thông số kỹ thuật trong thanh điều hướng bên.
  2. Nhấp vào + Spec (Quy cách).
  3. Nhấp vào Quy cách mới trong trình đơn thả xuống. Trình chỉnh sửa quy cách sẽ mở ra.
  4. Thay thế quy cách mẫu bằng thông tin chi tiết về OpenAPI Specification của riêng bạn.
    Xem phần Tạo quy cách bằng trình chỉnh sửa quy cách.
  5. Nhấp vào Lưu để lưu quy cách.
  6. Nhập tên cho quy cách khi được nhắc.
  7. Nhấp vào Lưu.

Nhập một đặc tả OpenAPI

Cách nhập một OpenAPI Specification:

  1. Nhấp vào Phát triển > Thông số kỹ thuật trong thanh điều hướng bên.
  2. Nhấp vào + Spec (Quy cách).
  3. Nhấp vào một trong các lựa chọn sau đây trong trình đơn thả xuống:
    • Nhập URL để nhập quy cách từ một URL. Chỉ định tên và URL khi được nhắc.
    • Nhập tệp để duyệt tìm quy cách trong thư mục cục bộ.
      Quy cách này sẽ được thêm vào danh sách.
  4. Nhấp vào tên của quy cách để xem và chỉnh sửa quy cách đó trong trình chỉnh sửa quy cách.
    Xem phần Tạo quy cách bằng trình chỉnh sửa quy cách.

Chỉnh sửa một OpenAPI Specification hiện có

Cách mở một OpenAPI Specification hiện có:

  1. Nhấp vào Phát triển > Thông số kỹ thuật trong thanh điều hướng bên.
  2. Nhấp vào hàng liên kết với quy cách trong danh sách quy cách.
  3. Chỉnh sửa quy cách trong trình chỉnh sửa quy cách.
    Xem phần Tạo quy cách bằng trình chỉnh sửa quy cách.

Tạo một proxy API từ một quy cách trong danh sách quy cách

Với Apigee Edge, bạn có thể tạo các proxy API từ các Thông số kỹ thuật OpenAPI mà bạn thiết kế và lưu trong trình chỉnh sửa thông số kỹ thuật. Chỉ bằng vài cú nhấp chuột, bạn sẽ có một proxy API trong Apigee Edge với các đường dẫn, tham số, luồng có điều kiện và điểm cuối đích được tạo tự động. Sau đó, bạn có thể thêm các tính năng như bảo mật OAuth, giới hạn tốc độ và lưu vào bộ nhớ đệm.

Sau khi tạo một API proxy từ một OpenAPI Specification, nếu thông số kỹ thuật đó được sửa đổi, bạn sẽ cần sửa đổi API proxy theo cách thủ công để phản ánh những thay đổi đã triển khai. Xem phần Điều gì sẽ xảy ra nếu tôi sửa đổi một quy cách?.

Cách tạo một proxy API từ một OpenAPI Specification trong danh sách đặc tả:

  1. Chọn Phát triển > Thông số kỹ thuật trong trình đơn điều hướng bên.
  2. Chuyển đến thư mục chứa OpenAPI Specification (nếu cần).
  3. Đặt con trỏ lên OpenAPI Specification mà bạn muốn tạo một proxy API để hiển thị trình đơn thao tác.
  4. Nhấp vào tạo proxy. Trình hướng dẫn Create Proxy (Tạo proxy) sẽ mở ra và trang Proxy details (Thông tin chi tiết về proxy) sẽ được điền sẵn bằng các giá trị trong OpenAPI Specification (Quy cách OpenAPI), như minh hoạ trong hình sau.
    xây dựng trình hướng dẫn proxy
  5. Nhấp vào Tiếp theo.
  6. Chuyển qua các trang còn lại trong trình hướng dẫn Tạo proxy, như mô tả trong phần Tạo một proxy API từ một Thông số kỹ thuật OpenAPI. (Bắt đầu từ bước 8.)

Đổi tên quy cách

Cách đổi tên quy cách:

  1. Chọn Phát triển > Thông số kỹ thuật trong trình đơn điều hướng bên.
  2. Chuyển đến thư mục chứa quy cách (nếu cần).
  3. Đặt con trỏ lên quy cách mà bạn muốn đổi tên để trình đơn thao tác xuất hiện.
  4. Nhấp vào Đổi tên quy cách.
  5. Chỉnh sửa tên quy cách.
  6. Nhấp vào Đổi tên để lưu nội dung chỉnh sửa hoặc nhấp vào Huỷ để huỷ.

Di chuyển một quy cách sang một thư mục

Bạn có thể sắp xếp các quy cách thành thư mục để dễ dàng quản lý và bảo mật. Để di chuyển một quy cách vào thư mục, hãy xem bài viết Sắp xếp quy cách bằng thư mục.

Xoá quy cách

Bạn có thể xoá một quy cách khỏi kho lưu trữ tệp khi quy cách đó không còn cần thiết hoặc trở nên không hợp lệ.

Cách xoá một quy cách:

  1. Chọn Phát triển > Thông số kỹ thuật trong trình đơn điều hướng bên.
  2. Đặt con trỏ lên thông số kỹ thuật mà bạn muốn xoá để trình đơn thao tác xuất hiện.
  3. Nhấp vào Biểu tượng xoá.
  4. Nhấp vào Xoá để xác nhận thao tác xoá khi được nhắc.
  5. Xoá các cấu phần phần mềm liên quan không còn cần thiết.