Documents API
List Documents
http
GET /api/v1/documentsQuery parameters
| Parameter | Type | Description |
|---|---|---|
| page | number | Page number, default 1 |
| pageSize | number | Items per page, default 20 |
| category | string | Filter by category |
| keyword | string | Keyword search |
Get Document Details
http
GET /api/v1/documents/:idCreate Document
http
POST /api/v1/documentsRequest parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| title | string | Yes | Document title |
| content | string | Yes | Document content (Markdown) |
| category | string | No | Category ID |
Update Document
http
PUT /api/v1/documents/:idDelete Document
http
DELETE /api/v1/documents/:idGet Document Categories
http
GET /api/v1/documents/categoriesExample response
json
{
"code": 0,
"data": [
{
"id": "1",
"name": "User Guide",
"count": 10
},
{
"id": "2",
"name": "API Docs",
"count": 5
}
]
}