4.1 General Parameter Format
The API interface supports two ways of parameter transmission:
- Query ParameterPassed through the URL query string, suitable for GET requests
- Body parametersPassed through the request body, suitable for POST requests
4.2 Pagination Parameter Description
Most list interfaces support pagination, the common pagination parameters include:
| Parameter Name | Type | Description |
|---|---|---|
| page | int | Page number, default is 1, used by some interfacescurrentAs the current page number, please refer to the actual interface |
| limit | int | Number of items per page, default is 10, used in some interfacespaegSizeAs the number of items per page, please refer to the actual interface |
| offset | int | Offset, used for more flexible pagination, some interfaces may not support it, please refer to the actual interface |
4.3 Sorting parameter description
Sorting parameters are used to control the order of the returned data:
| Parameter Name | Type | Description |
|---|---|---|
| order | string | Sorting method, such asid desc/created_time asc |
4.4 Parameter selection description
Parameter selection is used to filter data:
| Parameter Name | Type | Description |
|---|---|---|
| q | string | Search keywords |
| type | string | List type filter, type="list" does not include pagination, type="page" includes pagination |
| flag | string | Recommended attribute filtering, supported flag values are: Headline [h] Recommendation [c] Slide [f] Special Recommendation [a] Scrolling [s] Bold [h] Image [p] Jump [j] |