Skip to content

Carousel Management

Interfaces for managing homepage carousels.

Get all carousels.

Interface Information

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

Create new carousel.

Interface Information

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

Request Parameters

ParameterTypeRequiredDescription
titlestringYesCarousel title
imageUrlstringYesImage URL
linkUrlstringNoLink address
ordernumberNoSort order, default 0
statusstringNoStatus: active/inactive, default active

Request Example

bash
curl -X POST http://localhost:3000/api/admin/carousels \
  -H "Authorization: Bearer your-jwt-token" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Welcome to My Blog",
    "imageUrl": "https://example.com/banner.jpg",
    "linkUrl": "/articles/1",
    "order": 1
  }'

Update existing carousel.

Interface Information

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

Request Example

bash
curl -X PUT http://localhost:3000/api/admin/carousels/1 \
  -H "Authorization: Bearer your-jwt-token" \
  -H "Content-Type: application/json" \
  -d '{
    "order": 2
  }'

Delete specified carousel.

Interface Information

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

Request Example

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

Error Responses

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