API Search

🔍 API Search

Tổng quan

API Search là một tính năng tìm kiếm thống nhất cho phép người dùng tìm kiếm và xem các API đã đăng ký bằng nhiều điều kiện khác nhau.

 Path: Left Sidebar > API Search

Feature Overview

Trên trang API Search, người dùng có thể tìm kiếm và xem kết quả của các API bằng nhiều điều kiện như project, URL Gateway (Tên miền), API name, Path, method, và nhiều hơn nữa. Kết quả tìm kiếm có thể được xem dưới dạng bảng OR thẻ, và xuất ra định dạng CSV, JSON, OR Excel.

---

Page Structure

1. Search Filters Section

Phần này cho phép người dùng thiết lập filter để xác định các điều kiện tìm kiếm.

Filter Options 

Filter Item	Description	ví dụ Input
Project	Chọn project (hỗ trợ chọn nhiều)	Chọn project từ danh sách thả xuống
Method	Lọc method HTTP (GET, POST, PUT, DELETE, v.v.)	Chọn GET, POST, v.v.
Gateway URL	Tìm kiếm keyword URL Gateway (tìm kiếm LIKE)	api.skapim.com
API Name	Tìm kiếm keyword API name (tìm kiếm LIKE)	api01
Request (Body, Parameters)	Tìm kiếm keyword trong Request Body, QueryParameters, PathParameters	orderId, userId
Response (Body)	Tìm kiếm keyword trong body phản hồi	orderId, userId
API Base Path	Tìm kiếm API Base Path	/api/v1/orders
Path	Tìm kiếm các Path API sau API Base Path.	/api/v1/orders
Swagger Tag	Tìm kiếm Swagger Tag	order
Description or Summary	Tìm kiếm keyword Description OR Summary (tìm kiếm LIKE)	Nhập các keyword có trong Description OR Summary
Search Filter Buttons

• Reset: Xóa tất cả filter
• Search: Thực hiện tìm kiếm với các điều kiện đã chọn

Search filter hoạt động như thế nào

1. Kết hợp các điều kiện giữa các filters  (Điều kiện AND)

Mỗi filter được kết hợp với điều kiện AND. 

Ví dụ:

Project A VÀ Method GET

• Chỉ các API với Project "A" và method "GET" được tìm kiếm.

2. Kết hợp nhiều giá trị trong một filter duy nhất (điều kiện OR)

Khi nhiều giá trị được chọn OR nhập trong một filter duy nhất, chúng được kết hợp bằng cách sử dụng điều kiện OR. 

Ví dụ:

project A VÀ (method GET OR POST)

• Các API với project "A" và method "GET" OR “POST” được tìm kiếm.

3. Keyword Search (LIKE Search) 

Tất cả các giá trị đầu vào filter (keyword) được tìm kiếm nếu chúng có chứa giá trị đã nhập (LIKE %KEYWORD% search).

Features:

• Độ nhạy chữ hoa chữ thường có thể thay đổi tùy thuộc vào cấu hình hệ thống.
• Tìm kiếm khớp một phần được hỗ trợ, vì vậy không cần phải có tên chính xác đầy đủ.

ví dụ:

• Nhập api trong URL Gateway → api.skapim.com, apistg.skapim.com, v.v. được tìm kiếm
• Nhập auth trong API name → my-core-auth, user-auth, auth-service, v.v. được tìm kiếm
• Nhập login trong Description → tất cả API chứa “login” được tìm kiếm

Composite Search ví dụ:

Filter Setting	Search Result
project: pjt01 method: GET	Các API với project "pjt01" và method "GET"
URL Gateway: api API name: auth	"api" được bao gồm trong URL Gateway VÀ "auth" được bao gồm trong API name
method: GET OR POST Path: /v1	(method là "GET" OR "POST") VÀ "/v1" được bao gồm trong Path

💡 Mẹo:

• Nhiều filter có thể được kết hợp (AND) để thu hẹp chính xác kết quả tìm kiếm API.
• Thiết lập nhiều giá trị trong một filter duy nhất (OR) cho phép phạm vi tìm kiếm rộng hơn.
• Tìm kiếm theo keyword (LIKE) hỗ trợ khớp một phần, vì vậy tên chính xác đầy đủ không cần thiết.

---

2. Search Results Area

Statistics Information

Các thống kê sau được hiển thị ở đầu kết quả tìm kiếm:

• Total APIs – số lượng API khớp
• Total Endpoints – số lượng endpoint khớp
• Related Projects – số lượng project liên quan

Switch View Mode

• Table View: Hiển thị kết quả tìm kiếm dưới dạng bảng (mặc định).
• Card View: Hiển thị kết quả tìm kiếm dưới dạng thẻ.

Export Function

Kết quả tìm kiếm có thể được xuất dưới dạng tệp:

• CSV: xuất dưới dạng định dạng CSV
• JSON: xuất dưới dạng định dạng JSON
• Excel: xuất dưới dạng định dạng Excel

Column Settings

Cho phép chọn các cột nào để hiển thị trong bảng.

---

3. Search Results Table

Table Columns:

Column name	Description
Project name	Project name
API name	API name
Gateway URL	Gateway URL
API Base Path	API Base Path
Path	Path API (Ví dụ: /v1/poc-tcom-cd/...)
Swagger Tag	Swagger Tag
method	method HTTP (GET, POST, PUT, v.v.)
Summary	Thông tin Summary API
Description	Description API
Details	Xem thông tin Details

Table Functions:

• Pagination: Hiển thị kết quả theo trang khi số lượng kết quả tìm kiếm lớn (ví dụ: 10 mục mỗi trang).
• Sorting: Cho phép thay đổi thứ tự sắp xếp bằng cách nhấp vào tiêu đề cột (khi được hỗ trợ).
• Details: Hiển thị thông tin Details thông qua button trong cột Details.
• Method Tag: Các method được hiển thị dưới dạng thẻ mã màu (chip), chẳng hạn như GET, POST, PUT, v.v.

---

Cách Sử Dụng

Tìm Kiếm Cơ Bản

1. Chọn menu “API Search” từ thanh bên trái
2. Đặt các điều kiện tìm kiếm mong muốn trong phần  Search Filters .
3. Nhấn button Search  để thực hiện tìm kiếm.

Ví Dụ Tìm Kiếm Nâng Cao

ví dụ 1: Search for GET‑method APIs in a specific project  

1. Chọn một project từ dropdown Project 
2. Chọn biểu mẫu “GET” từ dropdown Method
3. Nhấn button Search 

ví dụ 2: Search for APIs by Gateway URL  

1. Nhập api.skapim.com vào trường nhập Gateway URL
2. Nhấn button Search

ví dụ 3: Search by API Name & Description  

1. Nhập bw-core-auth vào trường nhập API name
2. Nhập keyword vào trường nhập  Description or Summary
3. Nhấn button Search 

ví dụ 4: Search by Path pattern  

1. Nhập /api/v1/orders vào trường nhập Path
2. Nhấn button Search 

Cách sử dụng kết quả tìm kiếm

1. Switch between table and card view: Thay đổi chế độ hiển thị bằng cách sử dụng button Table View OR Card View
2. View details: Nhấn button trong cột Details của bảng
3. Export results: Tải xuống tệp bằng cách nhấn button CSV, JSON OR Excel .
4. Column settings: Chọn các cột nào để hiển thị bằng cách sử dụng button Column Settings.

Đặt lại điều kiện tìm kiếm

• Nhấn button Reset để đặt lại tất cả các filter tìm kiếm.

---

Chi tiết các key function

Keyword Search (LIKE search)

Tất cả các trường nhập keyword đều hỗ trợ tìm kiếm LIKE %KEYWORD%. Nếu giá trị chứa giá trị, nó sẽ được tìm kiếm.

Keyword Search Fields:

• Gateway URL: Tìm kiếm các keyword có trong URL Gateway
• API Name: Tìm kiếm các keyword có trong API name
• Request (Body, Parameters): Tìm kiếm các keyword có trong Body OR Tham số Yêu cầu
• Response (Body): Tìm kiếm các keyword có trong body phản hồi
• API Base Path: Tìm kiếm các keyword có trong API Base Path
• Path: Tìm kiếm các keyword có trong Path API
• Swagger Tag: Tìm kiếm các keyword có trong Swagger Tag
• Description or Summary: Tìm kiếm các keyword có trong Description OR Summary

ví dụ:

• Nhập otel vào URL Gateway → otel-gw.api.skapim.com, v.v. sẽ được tìm kiếm
• Nhập auth vào API name → bw-core-auth, user-auth, v.v. sẽ được tìm kiếm
• Nhập /v1/board vào Path → /v1/board, /v1/board/{id}, v.v. sẽ được tìm kiếm

💡 Tip: Tìm kiếm khớp một phần được hỗ trợ, vì vậy không cần thiết phải có tên chính xác đầy đủ.

Tìm kiếm Đa điều kiện

Sử dụng nhiều filter cùng nhau cho phép tìm kiếm chính xác hơn. Ví dụ:

• project + Method
• URL Gateway + API name
• Path + Swagger Tag

Xuất Kết quả

Kết quả tìm kiếm có thể được xuất ra nhiều định dạng khác nhau để sử dụng trong các công cụ OR tài liệu khác:

• CSV: Có thể mở trong bảng tính
• JSON: Phù hợp cho xử lý lập trình
• Excel: Lưu kết quả dưới dạng tệp Excel

---

Mẹo Sử Dụng

1. Combine Search Conditions: Sử dụng nhiều filter để nhanh chóng tìm API mong muốn
2. Use Keyword Search: Hữu ích khi tên chính xác không được biết
3. Check Statistics information: Sử dụng thống kê ở đầu kết quả để hiểu phạm vi tổng thể
4. Switch View mode: Chuyển đổi giữa chế độ xem Bảng và chế độ xem Thẻ dựa trên sở thích
5. Use Export options: Lưu kết quả tìm kiếm để chia sẻ OR tài liệu
6. Use Pagination: Sử dụng phân trang để điều hướng hiệu quả khi có nhiều kết quả

---

Thông tin chi tiết về API

How to Access: Nhấp vào button trong cột Details của bảng kết quả tìm kiếm.

Khi button Details cho một API được nhấp trong bảng kết quả tìm kiếm, một cửa sổ modal mở ra hiển thị thông tin Details về API đó.

Cấu trúc Modal

Modal Features

• Overlay: Một lớp tối chặn tương tác bên ngoài modal
• Responsive Design: Tự động điều chỉnh kích thước dựa trên kích thước màn hình
• Close Options: Nhấp ra ngoài modal OR sử dụng button đóng (✕)

Các phần chính

1. API Information Section (api-info-section)

Hiển thị thông tin cơ bản về API:

• API Name: API name (ví dụ: bw-core-auth)
• Base Path: API Base Path (ví dụ: /bw-core-auth)
• Gateway URL: URL Gateway (ví dụ: otel-gw.api.skapim.com)
• Open API Document: button để mở liên kết tài liệu OpenAPI

2. Endpoints Section (endpoints-section)

Hiển thị thông tin Swagger và danh sách các endpoint:

• Swagger Information:
  • Tổng số endpoint (ví dụ: 198 endpoint)
• Endpoint List :
  • Method: method HTTP (GET, POST, PUT, v.v.), hiển thị dưới dạng định dạng chip
  • Path: Path API (ví dụ: /v1/poc-tcom-cd/get-plyz-ppay-yn)
  • Summary:  Summary API (ví dụ: getPlayzPpayYn)
  • Swagger Tag: Swagger Tag (ví dụ: poc-tcom-cd-controller)
  • Related Endpoints: button để xem các endpoint liên quan

Các tính năng chính

1. View Endpoint Information

• Thông tin về method, Path, Summary và Swagger Tag cho mỗi endpoint có thể được xem
• Các method được hiển thị dưới dạng các chip mã màu để dễ dàng phân biệt trực quan

2. Test or Execute an API Endpoint

• Nếu bạn nhấp vào button phát (▶) nằm ở bên phải của mỗi endpoint, bạn có thể chuyển đến màn hình kiểm tra OR màn hình thực thi cho endpoint API đó.
• Nếu button Phát được nhấp:
  • Giao diện kiểm tra API sẽ được hiển thị, OR
  • Bạn có thể được điều hướng đến màn hình thực thi, OR
  • Thông tin thực thi Details sẽ được hiển thị
• Tính năng này cho phép kiểm tra trực tiếp API và xác minh hành vi.

3. Browse Related Endpoints

• Nhấp vào button Related Endpoints sẽ hiển thị các endpoint liên quan khác.

4. Open the OpenAPI Document

• Nhấp vào Open API Document để mở tài liệu OpenAPI đầy đủ của API này.

5.  Close the Modal

• Nhấp vào button ✕ ở góc trên bên phải của hộp thoại
• OR nhấp ra ngoài hộp thoại (khu vực phủ)

How to Use

1. Run API search: Đặt các filter tìm kiếm và nhấp vào button Search  để hiển thị kết quả.
2. Click Details button: Nhấp vào button Details  trong cột Details của hàng API mong muốn trong bảng kết quả tìm kiếm.
3. View the modal: Hộp thoại Details API sẽ mở ra
4. Check information:
   • Trong API Information section, thông tin cơ bản về API có thể được xem.
   • Trong Endpoints section, thông tin Swagger và danh sách các endpoint có thể được xem.
   • Nhấp vào button phát (▶) bên cạnh một endpoint để chuyển đến màn hình kiểm tra OR thực thi API.
   • Nhấp vào button Related Endpoints để khám phá các endpoint liên quan.
   • Nhấp vào button Open API Document để xem tài liệu OpenAPI.
5. Close the Modal

• Nhấn button đóng (✕) ở góc trên bên phải của modal, OR
• Nhấn bên ngoài modal (overlay) để đóng nó

Ví dụ Sử Dụng

ví dụ 1: Checking basic API information

1. Nhấn button Details cho API bw-core-auth trong kết quả tìm kiếm.
2. Kiểm tra Path Cơ sở và Gateway URL trong phần Thông tin API.
3. Kiểm tra số lượng endpoint (ví dụ: 198 ae).

ví dụ 2: Viewing specific endpoint information

1. Kiểm tra danh sách các endpoint trong modal Details
2. Phân biệt GET/POST/PUT bằng cách sử dụng các thẻ method
3. Hiểu chức năng của từng endpoint thông qua Path và Summary của nó

ví dụ 3: Viewing OpenAPI documentation 

1. Nhấn button Open API Document trong modal Details
2. Xem tài liệu OpenAPI trong một cửa sổ OR tab mới

ví dụ 4: Testing an API endpoint 

1. Tìm endpoint để kiểm tra trong modal Details
2. Nhấn Play button (▶) bên cạnh endpoint đó
3. Trong màn hình kiểm tra/thực thi API, gọi API trực tiếp và kiểm tra kết quả
4. Cấu hình/thay đổi tham số yêu cầu, tiêu đề và nội dung để kiểm tra các kịch bản khác nhau

ví dụ 5: Viewing related endpoints 

1. Nhấn button Related Endpoints cho endpoint đã chọn
2. Kiểm tra danh sách các endpoint liên quan khác

Cách sử dụng API Test popup

• Click Play button: Nhấn button Phát (▶) ở bên phải của một endpoint mở ra popup API Test 

• Execute Try it out : Nhấn Try it out trong Swagger UI để gọi và xem kết quả trong bảng bên phải. 

  • Các mục cần kiểm tra: Response code, response body, response time, v.v.

• Save to History: Nhấn Save button ở góc trên bên phải của bảng kết quả để lưu kết quả kiểm tra vào Lịch sử. 

• View History: Mở tab History  ở trên để kiểm tra các bản ghi thử nghiệm đã lưu.

• Share a Link: Nhấp vào button Share  trong Lịch sử để chia sẻ test result dưới dạng liên kết.

• Re-open link: Dán liên kết đã chia sẻ vào thanh địa chỉ của trình duyệt để mở màn hình Lịch sử đã lưu và xem lại các test details tương tự.