Skip to content

Documents API

List Documents

http
GET /api/v1/documents

Query parameters

ParameterTypeDescription
pagenumberPage number, default 1
pageSizenumberItems per page, default 20
categorystringFilter by category
keywordstringKeyword search

Get Document Details

http
GET /api/v1/documents/:id

Create Document

http
POST /api/v1/documents

Request parameters

ParameterTypeRequiredDescription
titlestringYesDocument title
contentstringYesDocument content (Markdown)
categorystringNoCategory ID

Update Document

http
PUT /api/v1/documents/:id

Delete Document

http
DELETE /api/v1/documents/:id

Get Document Categories

http
GET /api/v1/documents/categories

Example response

json
{
  "code": 0,
  "data": [
    {
      "id": "1",
      "name": "User Guide",
      "count": 10
    },
    {
      "id": "2",
      "name": "API Docs",
      "count": 5
    }
  ]
}
最近更新