About Inquiry
Queries are the core component of GraphQL API, used to retrieve data from the server.Through the defined query fields, the client can precisely request the required data, avoiding the acquisition of unnecessary information.This system provides a rich set of query interfaces, covering content management, user information, product data, comment systems, and more, meeting the data acquisition needs of various application scenarios.
The query interface supports various parameters, allowing data to be filtered, sorted, and paginated, making data retrieval more flexible and efficient.Each query has a clear return type, ensuring that the client can accurately expect the returned data structure.
archive
Type:Archive
Get document or product details
This query is used to retrieve detailed information about a single document or product, supporting multiple ways to locate the target document, including ID, URL alias, and so on.Can be used to obtain articles, products, and other specific content, supporting verification access to password-protected content, as well as HTML rendering functionality for Markdown content.
Parameters
| Name | Description |
|---|---|
| password (String) | Document protected by a password, full content can only be obtained after verification with the password |
| id (Int) | Document ID |
| filename (String) | file name, equivalent to url_token |
| url_token (String) | Document alias. Special values: previous: prev, next: next |
| render (Boolean) | If it is a Markdown editor, set render to true to render the content in HTML format |
archiveParams
Type:[CustomField]
Get document custom field
This query is used to retrieve custom field information for a specific document.In a content management system, different documents may require specific custom attributes or extended fields. This interface allows clients to retrieve this additional field data to better display or process the extended information of the documents.
Custom fields are typically used to store additional attributes of documents, such as SEO settings, special configuration options, and business-related extended data, making the document system more flexible and extensible.
Parameters
| Name | Description |
|---|---|
| filename (String) | file name, equivalent to url_token |
| url_token (String) | Document Alias |
| render (Boolean) | Whether to Render Content |
| id (Int) | Document ID |
Archives
Type:Archive List
Get document list
This query is used to retrieve the list data of documents or products, supporting various filtering and sorting methods.Through this interface, the client can obtain a collection of documents such as articles and products, suitable for scenarios that require displaying multiple documents, such as the homepage, category pages, and search results pages.
This query interface provides a variety of parameter options, enabling pagination, filtering, sorting, and searching functions, to meet the needs of displaying document lists in various business scenarios.
Parameters
| Name | Description |
|---|---|
| parent_id (Int) | Parent ID |
| exclude_category_id (Int) | Exclude Category ID |
| exclude_category_ids ([Int]) | List of excluded category IDs |
| module_id (Int) | Model ID |
| user_id (Int) | User ID |
| show_flag (Boolean) | Whether to display the flag |
| draft (Boolean) | Whether to display the draft |
| author_id (Int) | Author ID |
| q (String) | Search keywords |
| like (String) | Fuzzy search keyword |
| keywords (String) | keyword search |
| type (String) | type filter |
| limit (Int) | Limit the number of returns |
| render (Boolean) | Whether to Render Content |
| category_id (Int) | Category ID |
| tag_id (Int) | Tag ID |
| flag (String) | flag filter |
| page (Int) | page number |
| category_ids ([Int]) | Category ID list |
| show_content (Boolean) | Show content |
| show_extra (Boolean) | Show extra fields |
| child (Boolean) | whether it includes child categories |
| order (String) | Sorting method |
| tag (String) | label filter |
| offset (Int) | offset amount |
| id (Int) | specific ID |
banners
Type:[BannerItem]
Get the homepage carousel
Parameters
| Name | Description |
|---|---|
| type (String) | Carousel type |
categories
Type:[Category]
Get category list
Parameters
| Name | Description |
|---|---|
| parent_id (Int) | Parent category ID |
| module_id (Int) | Model ID |
| all (Boolean) | Whether to get all categories |
| limit (Int) | Limit the number of returns |
| offset (Int) | offset amount |
category
Type:Category
Get category details
Parameters
| Name | Description |
|---|---|
| id (Int) | Category ID |
| filename (String) | file name, equivalent to url_token |
| catname (String) | Category name |
| url_token (String) | Category Alias |
| render (Boolean) | Whether to Render Content |
comments
Type:Comment List
Get comment list
Parameters
| Name | Description |
|---|---|
| order (String) | Sorting method |
| page (Int) | page number |
| limit (Int) | Limit the number of returns |
| offset (Int) | offset amount |
| render (Boolean) | Whether to Render Content |
| id (Int) | Comment ID |
| user_id (Int) | User ID |
contact
Type:Contact Setting
Get contact information
Currency
Type:Currency Setting
Get currency information
diy
Type:[ExtraField]
Get system custom field
Parameters
| Name | Description |
|---|---|
| render (Boolean) | Whether to Render Content |
filters
Type:[FilterGroup]
Get document, product filtering fields
Parameters
| Name | Description |
|---|---|
| module_id (Int) | Model ID |
| show_all (Boolean) | Whether to display all filter options |
| all_text (String) | Text displayed for 'All' |
| show_price (Boolean) | [Show Price Filter] |
friendLinks
Type:[FriendLink]
[Get Friendship Links]
guestbookFields
Type:[CustomField]
Get留言字段configuration
index
Type:IndexSetting
Get Home Page TDK Information
languages
Type:[MultiLangSite]
Get Multilingual Site Information
metadata
Type:PageMeta
Retrieve current page metadata
Parameters
| Name | Description |
|---|---|
| path (String) | Page path |
| params (JSON) | Page parameters |
module
Type:Module
Get module detail
Parameters
| Name | Description |
|---|---|
| filename (String) | file name, equivalent to url_token |
| url_token (String) | Module Alias |
| id (Int) | Module ID |
modules
Type:[Module]
Get module list
navs
Type:[Nav]
Retrieve navigation list
Parameters
| Name | Description |
|---|---|
| type_id (Int) | Navigation Type ID |
| show_type (String) | Display Type |
page
Type:Page
Get single page details
Parameters
| Name | Description |
|---|---|
| render (Boolean) | Whether to Render Content |
| id (Int) | Page ID |
| filename (String) | file name, equivalent to url_token |
| url_token (String) | Page Alias |
Pages
Type:[Page]
Get single page list
Parameters
| Name | Description |
|---|---|
| limit (Int) | Limit the number of returns |
| offset (Int) | offset amount |
reviews
Type:ReviewList
Get product review list
Parameters
| Name | Description |
|---|---|
| user_id (Int) | User ID |
| order (String) | Sorting method |
| page (Int) | page number |
| limit (Int) | Limit the number of returns |
| offset (Int) | offset amount |
| render (Boolean) | Whether to Render Content |
| id (Int) | Review ID |
sku
Type:Sku
Retrieve product SKU information
Parameters
| Name | Description |
|---|---|
| id (Int) | Product ID |
| filename (String) | file name, equivalent to url_token |
| url_token (String) | Product alias |
system
Type:System Setting
Retrieve system settings information
tag
Type:Tag
Retrieve document, product tag details
Parameters
| Name | Description |
|---|---|
| url_token (String) | Tag alias |
| render (Boolean) | Whether to Render Content |
| id (Int) | Tag ID |
| filename (String) | file name, equivalent to url_token |
tags
Type:TagList
Get tag list
Parameters
| Name | Description |
|---|---|
| letter (String) | Initial letter filtering |
| page (Int) | page number |
| item_id (Int) | Project ID |
| category_id (Int) | Category ID |
| type (String) | type filter |
| order (String) | Sorting method |
| limit (Int) | Limit the number of returns |
| offset (Int) | offset amount |
| category_ids ([Int]) | Category ID list |
user
Type:User
Get user information
Parameters
| Name | Description |
|---|---|
| id (Int) | User ID |
Example Usage
Get details of a single document
query GetArchive {
archive(id: 1, render: true) {
id
title
content
category {
name
}
tags {
name
}
}
}
Get document list
query GetArchives {
archives(limit: 10, page: 1, category_id: 1) {
list {
id
title
summary
created_at
}
pagination {
total
page
limit
}
}
}
Get category information
query GetCategory {
category(id: 1) {
id
name
description
archives(limit: 5) {
list {
id
title
}
}
}
}
Get comment list
query GetComments {
comments(page: 1, limit: 20, order: "created_at desc") {
list {
id
content
author
created_at
}
pagination {
total
page
limit
}
}
}
Get Custom Field
query GetArchiveParams {
archiveParams(id: 1) {
name
value
type
}
}
Get navigation menu
query GetNavs {
navs(type_id: 1) {
id
name
url
children {
id
name
url
}
}
}
Get system settings
query GetSystemInfo {
system {
site_name
site_url
site_logo
seo_title
seo_keywords
seo_description
}
}
