Skip to content

Category Management

Interfaces for managing article and project categories.

Get Category List

Get all category lists.

Interface Information

  • Endpoint: GET /api/admin/categories
  • Authentication: Required (admin permission)

Create Category

Create new category.

Interface Information

  • Endpoint: POST /api/admin/categories
  • Authentication: Required (admin permission)

Request Parameters

ParameterTypeRequiredDescription
namestringYesCategory name
typestringNoType: article/project, default article
descriptionstringNoCategory description

Request Example

bash
curl -X POST http://localhost:3000/api/admin/categories \
  -H "Authorization: Bearer your-jwt-token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Technical Sharing",
    "type": "article",
    "description": "Sharing technical articles"
  }'

Update Category

Update existing category.

Interface Information

  • Endpoint: PUT /api/admin/categories/:id
  • Authentication: Required (admin permission)

Request Example

bash
curl -X PUT http://localhost:3000/api/admin/categories/1 \
  -H "Authorization: Bearer your-jwt-token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Category Name"
  }'

Delete Category

Delete specified category.

Interface Information

  • Endpoint: DELETE /api/admin/categories/:id
  • Authentication: Required (admin permission)

Request Example

bash
curl -X DELETE http://localhost:3000/api/admin/categories/1 \
  -H "Authorization: Bearer your-jwt-token"

Error Responses

HTTP Status CodeDescription
401Not logged in or token invalid
403Insufficient permission (non-admin)
404Category does not exist
400Parameter error
500Server error