Three, Detailed Explanation of API Interface Classification

Here are the API interface categories provided by AnQiCMS, as well as some interface parameters. For more documentation interfaces and parameter configurations, please refer to the detailed documentation.

3.1 Content Management Interface

The Content Management Interface is used to handle the core content of the website, including documents, categories, tags, etc.

3.1.1Get document details interface

Interface Path:/api/archive/detail
Request Method: GET
FeatureGet detailed information of a single document
Parameter:
- id(int, required) - Document ID
- filename(string, optional) - Document URL alias (id/filename either one)
- render(boolean, optional) - Whether to render the content as HTML (Markdown document rendering), default is true

3.1.2to get the document list interface

Interface Path:/api/archive/list
Request Method: GET
Feature: Get document list
Parameter:
- moduleId(int, optional) - Model ID
- categoryId(string, optional) - Category ID, multiple IDs can be separated by commas
- limit(int, optional) - Display count
- page(int, optional) - Page number
- order(string, optional) - Sort method, such asid desc

3.1.3Get Document Parameters Interface

Interface Path:/api/archive/params
Request Method: GET
Feature: Retrieve document custom parameters
Parameter:
- id(int, required) - Document ID
- filename(string, optional) - Document URL alias (id/filename either one)
- sorted(int, optional) - Return format, true for array format, false for object format

3.1.4Get Category Detail Interface

Interface Path:/api/category/detail
Request Method: GET
Feature: Get category details information
Parameter:
- id(int, optional) - Category ID
- filename(string, optional) - Category URL alias

3.1.5Get Category List Interface

Interface Path:/api/category/list
Request Method: GET
Feature: Get the category list
Parameter:
- moduleId(int, optional) - Model ID
- parentId(int, optional) - Parent Category ID
- limit(int, optional) - Display count

3.1.6Get Tag List Interface

Interface Path:/api/tag/list
Request Method: GET
FeatureGet Tag List
Parameter:
- itemId(int, optional) - Document ID
- letter(string, optional) - Initial Letter Filter
- type(string, optional) - Return type

3.2 User Management Interface

The User Management Interface is used to handle user registration, login, information management, and other functions.

3.2.1User login interface

Interface Path:/api/login
Request Method: POST
Feature: User login authentication
Parameter:
- user_name(string, optional) - Username
- password(string, optional) - Password
- email(string, optional) - Email
- phone(string, optional) - Phone number

3.2.2User registration interface

Interface Path:/api/register
Request Method: POST
Feature: New user registration
Parameter:
- user_name(string, optional) - Username
- password(string, optional) - Password
- email(string, optional) - Email
- phone(string, optional) - Phone number
- captcha(string, optional) - Verification code

3.2.3Get user details interface

Interface Path:/api/user/detail
Request Method: GET
Feature: Get user details
Authentication required: Yes

3.2.4User favorite management

Get favorite list:/api/favorite/list
Add favorite:/api/favorite/add
Check collection status:/api/favorite/check
Remove favorite:/api/favorite/delete

3.3 Comment interaction interface

The comment interaction interface is used to handle user comments and interaction features.

3.3.1Get Comment List Interface

Interface Path:/api/comment/list
Request Method: GET
Feature: Get comment list
Parameter:
- archive_id(int, optional) - Document ID
- parent_id(int, optional) - Parent Comment ID
- limit(int, optional) - Display count

3.3.2Post comment interface

Interface Path:/api/comment/publish
Request Method: POST
Feature: Post Comment
Authentication required: Yes
Parameter:
- archive_id(int, required) - Document ID
- content(string, required) - Comment Content
- parent_id(int, optional) - Parent Comment ID