# Quản lý API

Một định nghĩa API hoàn chỉnh bao gồm "Thông tin cơ bản", "Định nghĩa yêu cầu API", "Định nghĩa Backend API" và "Định nghĩa phản hồi API". API có các thuộc tính là Region và Project. Sau khi đã định nghĩa, chúng không thể thay đổi.
*   Thông tin cơ bản bao gồm nhóm API, tên API và mô tả API. API chỉ có thể thuộc cùng một nhóm API của cùng một Region và cùng một Project, và không thể thay đổi sau khi đã định nghĩa.
*   Định nghĩa yêu cầu API hiện hỗ trợ ba giao thức: HTTP / HTTPS / HTTP(S). Hệ thống sử dụng giao thức + tên miền + đường dẫn + HTTPMethod được định nghĩa bởi API làm một URI duy nhất, URI này cần phải là độc nhất.
*   Hiện tại, yêu cầu backend chỉ hỗ trợ loại yêu cầu VPC, nó chỉ có thể được chọn sau khi tạo ủy quyền VPC.

## Tạo một API
* Thông tin cơ bản của API bao gồm nhóm mà API thuộc về, quy trình xử lý API và mô tả API. Tên định nghĩa API trong cùng một Region và cùng một Project không thể trùng nhau.
* Định nghĩa yêu cầu API bao gồm các giao thức được hỗ trợ, Path yêu cầu, mẫu khớp (matching pattern), HTTP Method và định nghĩa tham số đầu vào.
    * Giao thức yêu cầu: Giao thức yêu cầu hỗ trợ ba loại: http / https / http(s).
    * Mẫu khớp: Mẫu khớp đề cập đến phương thức khớp của Path yêu cầu. Nếu url của bạn là /userInfo và mẫu khớp là khớp tuyệt đối, thì Path yêu cầu phải nhất quán với định nghĩa. Nếu mẫu khớp là khớp tiền tố, thì nó có thể
    * Định nghĩa tham số đầu vào: Định nghĩa tham số đầu vào có hai loại: truyền tiếp tham số (parameter passthrough) và ánh xạ tham số (parameter mapping). Trong trường hợp truyền tiếp tham số, tất cả các tham số trong query / body / header của client sẽ được truyền đến backend. Bạn cũng có thể thêm Tham số Path (Path Parameter) được khuyến nghị bởi RestfulAPI trong Path yêu cầu. Khi sử dụng PathParameter, bạn phải sử dụng ánh xạ tham số đầu vào và bạn cần định nghĩa các tham số trong Path, chọn Path, bắt buộc. Ví dụ: nếu Path yêu cầu được định nghĩa là /userInfo/[userId], bạn có thể đặt tham số userId vào danh sách tham số. Các đường dẫn yêu cầu khớp là /userInfo , /userInfo/ , /userInfo/get.

* Trong yêu cầu backend API, bạn cần thiết lập dịch vụ backend và Path yêu cầu backend.
    * Dịch vụ backend, có thể lấy thông tin ủy quyền VPC từ kênh VPC, hoặc nhập thủ công ID ủy quyền VPC. Nhập thủ công thường được sử dụng trong trường hợp định nghĩa biến môi trường, phù hợp với tình huống mà cùng một chương trình cần chạy trên các máy chủ khác nhau.
    * Path yêu cầu backend có thể đặt các biến môi trường và các tham số yêu cầu backend, các tham số yêu cầu backend chỉ được sử dụng cho ánh xạ tham số.
   
   
* Trong định nghĩa phản hồi API, bạn có thể thiết lập ContentType, các ví dụ phản hồi thành công và thất bại, và định nghĩa các mã lỗi. ContentType sẽ được thêm vào HTTP Response Header theo thiết lập.