GraphQL plugin cung cấp nhiều nhóm API giúp lập trình viên và AI assistant khám phá hệ thống, đọc mô tả REST API, đọc schema giao diện, event, Ezy Function, template parameters, entity class và tải các SQL script đang được kích hoạt.

Hướng dẫn truy cập

Để truy cập các API do GraphQL plugin cung cấp, quản trị viên đăng nhập vào trang quản trị EzyPlatform, sau đó mở menu GraphQL ở thanh điều hướng bên trái và chọn mục Các loại API., ví dụ như ảnh bên dưới.

Giải thích các loại API

Tại trang Các loại API, hệ thống hiển thị danh sách các nhóm API được chia theo 2 phạm vi chính:

admin: schema/API của admin runtime.
web: schema/API của web runtime, được admin proxy sang web management API bằng access token quản trị.

Swagger

Swagger API trả về OpenAPI YAML cho REST API đã được hệ thống phát hiện.

Phạm vi	Endpoint	Content-Type	Mô tả
Admin	`GET /api/v1/rest/admin/swagger.yaml`	`application/x-yaml`	Trả Swagger YAML của admin REST API
Web qua admin	`GET /api/v1/rest/web/swagger.yaml`	`application/x-yaml`	Admin proxy sang web runtime để lấy Swagger YAML
Web public	`GET /api/v1/rest/swagger.yaml`	`application/x-yaml`	Trả Swagger YAML của web runtime nếu bật cấu hình REST API docs
Web management	`GET /management/api/v1/rest/swagger.yaml`	`application/x-yaml`	Endpoint management nội bộ của web runtime

Trang Swagger UI:

Phạm vi	Endpoint	Mô tả
Admin	`GET /rest/swagger/{target}`	Mở Swagger UI theo target, ví dụ `admin` hoặc `web`
Web	`GET /rest/swagger`	Mở Swagger UI của web nếu REST API docs đang bật

Lưu ý: web public Swagger phụ thuộc setting enable_rest_api_docs. Nếu tắt, endpoint public trả 404.

Model Context Protocol Server

MCP server được cung cấp tại:

GET /mcp
POST /mcp

GET /mcp trả metadata cơ bản:

{
  "name": "EzyPlatform GraphQL MCP",
  "protocolVersion": "2025-11-25",
  "endpoint": "/graphql/mcp",
  "methods": [
    "initialize",
    "notifications/initialized",
    "ping",
    "tools/list",
    "tools/call",
    "resources/list",
    "resources/read"
  ]
}

POST /mcp dùng JSON-RPC 2.0:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_admin_swagger",
    "arguments": {}
  }
}

MCP server hỗ trợ:

Method	Mô tả
`initialize`	Khởi tạo MCP session, trả protocol version, capabilities và server info
`notifications/initialized`	Nhận notification sau khi client initialized
`ping`	Kiểm tra kết nối
`tools/list`	Liệt kê tools
`tools/call`	Gọi một tool theo `name` và `arguments`
`resources/list`	Liệt kê resources
`resources/read`	Đọc nội dung resource

Các tool chính:

Tool	Arguments	Mô tả
`ping`	optional `message`	Kiểm tra MCP tool call
`get_admin_swagger`	none	Lấy Swagger YAML của admin
`get_web_swagger`	none	Lấy Swagger YAML của web
`get_admin_view_schema`	none	Lấy toàn bộ admin view schema
`get_admin_view_schema_by_uri`	`viewUri`	Lấy admin view schema theo URI
`get_web_view_schema`	none	Lấy toàn bộ web view schema
`get_web_view_schema_by_uri`	`viewUri`	Lấy web view schema theo URI
`get_admin_event_schema`	none	Lấy toàn bộ admin event schema
`get_admin_event_schema_by_name`	`eventName`	Lấy admin event schema theo tên event
`get_web_event_schema`	none	Lấy toàn bộ web event schema
`get_web_event_schema_by_name`	`eventName`	Lấy web event schema theo tên event
`get_admin_ezy_function_schema`	none	Lấy schema Ezy Function của admin
`get_web_ezy_function_schema`	none	Lấy schema Ezy Function của web
`get_admin_class_schema`	`classNames`	Lấy schema class trong admin runtime
`get_web_class_schema`	`classNames`	Lấy schema class trong web runtime
`get_admin_entity_class_schema`	none	Lấy schema entity class của admin
`get_admin_template_parameters_schema`	none	Lấy toàn bộ template parameters schema
`get_admin_template_parameters_schema_by_type_and_name`	`templateType`, `templateName`	Lấy template parameters schema cụ thể
`get_sql_scripts`	none	Lấy nội dung SQL scripts

View Schemas

View schema mô tả các view đã đăng ký trong runtime.

Phạm vi	Endpoint	Query	Mô tả
Admin	`GET /api/v1/schemas/admin/view`	none	Trả map toàn bộ admin view schema, key là `viewUri`
Admin	`GET /api/v1/schemas/admin/view/by-uri`	`viewUri`	Trả schema của một admin view
Web qua admin	`GET /api/v1/schemas/web/view`	none	Trả map toàn bộ web view schema
Web qua admin	`GET /api/v1/schemas/web/view/by-uri`	`viewUri`	Trả schema của một web view
Web management	`GET /management/api/v1/schemas/view`	none	Endpoint management của web runtime
Web management	`GET /management/api/v1/schemas/view/by-uri`	`viewUri`	Endpoint management lấy schema theo URI

Nếu không tìm thấy schema theo URI, API trả 404.

Event Schemas

Event schema mô tả các event mà runtime có thể xử lý.

Phạm vi	Endpoint	Query	Mô tả
Admin	`GET /api/v1/schemas/admin/event`	none	Trả map toàn bộ admin event schema
Admin	`GET /api/v1/schemas/admin/event/by-name`	`eventName`	Trả schema của một admin event
Web qua admin	`GET /api/v1/schemas/web/event`	none	Trả map toàn bộ web event schema
Web qua admin	`GET /api/v1/schemas/web/event/by-name`	`eventName`	Trả schema của một web event
Web management	`GET /management/api/v1/schemas/event`	none	Endpoint management của web runtime
Web management	`GET /management/api/v1/schemas/event/by-name`	`eventName`	Endpoint management lấy event schema theo tên

Nếu không tìm thấy event theo tên, API trả 404.

Ezy Function Schemas

Ezy Function schema là một nhóm đặc biệt của event schema, được lọc từ các event có prefix Ezy Function. Key trả về là tên function sau khi bỏ prefix.

Phạm vi	Endpoint	Mô tả
Admin	`GET /api/v1/schemas/admin/ezy-function`	Trả toàn bộ admin Ezy Function schema
Web qua admin	`GET /api/v1/schemas/web/ezy-function`	Trả toàn bộ web Ezy Function schema
Web management	`GET /management/api/v1/schemas/ezy-function`	Endpoint management của web runtime

Template Parameters Schemas

Template parameters schema mô tả các tham số mà template cần nhận.

Phạm vi	Endpoint	Mô tả
Admin	`GET /api/v1/schemas/admin/template-parameters`	Trả toàn bộ template parameters schema theo cấu trúc `templateType -> templateName -> schema`

Qua MCP có thể lấy schema cụ thể bằng tool:

{
  "name": "get_admin_template_parameters_schema_by_type_and_name",
  "arguments": {
    "templateType": "exampleType",
    "templateName": "exampleName"
  }
}

Entity Class Schemas

Entity class schema mô tả các JPA entity class được scan trong admin runtime.

Phạm vi	Endpoint	Mô tả
Admin	`GET /api/v1/schemas/admin/entity-class`	Trả danh sách entity class schema, sắp xếp theo `tableName`

Mỗi item có dạng:

{
  "tableName": "table_name",
  "entityClass": "com.example.EntityClass",
  "idClass": "java.lang.Long"
}

Class Schemas

Class schema mô tả field, read method và enum value của các class được yêu cầu.

Phạm vi	Endpoint	Query	Mô tả
Admin	`GET /api/v1/schemas/admin/classes`	`classNames`	Trả schema của các class trong admin runtime
Web qua admin	`GET /api/v1/schemas/web/classes`	`classNames`	Trả schema của các class trong web runtime
Web management	`GET /management/api/v1/schemas/classes`	`classNames`	Endpoint management của web runtime

Ví dụ:

GET /api/v1/schemas/admin/classes?classNames=com.example.User,com.example.Post

API chỉ trả schema cho class load được. Class không tồn tại hoặc không phù hợp sẽ bị bỏ qua.

Các mã SQL

SQL scripts API trả nội dung SQL tổng hợp từ:

script files của admin;
SQL script files trong các project/module đang active.
Phạm vi Endpoint Content-Type Mô tả
Admin GET /api/v1/sql-scripts text/plain Tải file sql-scripts.sql
MCP get_sql_scripts text content Trả nội dung SQL scripts qua MCP tool

Phạm vi	Endpoint	Content-Type	Mô tả
Admin	`GET /api/v1/sql-scripts`	`text/plain`	Tải file `sql-scripts.sql`
MCP	`get_sql_scripts`	text content	Trả nội dung SQL scripts qua MCP tool

Lưu ý: API này không sinh migration mới. Nó chỉ ghép nội dung các file SQL script hiện có thành một stream/file tải về.

Hướng dẫn truy cập xem danh sách loại API

Hướng dẫn truy cập

Giải thích các loại API

Swagger

Model Context Protocol Server

View Schemas

Event Schemas

Ezy Function Schemas

Template Parameters Schemas

Entity Class Schemas

Class Schemas

Các mã SQL

Table Of Contents

Hướng dẫn truy cập xem danh sách loại API

Hướng dẫn truy cập

Giải thích các loại API

Swagger

Model Context Protocol Server

View Schemas

Event Schemas

Ezy Function Schemas

Template Parameters Schemas

Entity Class Schemas

Class Schemas

Các mã SQL

Table Of Contents

Sign In

Register

Forgot Password

Send Successfully