Skip to content

API

Jump to bottom
Gugle edited this page Oct 18, 2023 · 5 revisions

基本

响应

  • 任何 JSON 格式的响应都会被以下格式包装 
    {
  "code": "code",
  "msg": "message",
  "data": {}
}

基础 /api

版本号

GET /api/version HTTP/1.1
Accept: application/json
  • Response 
    {
  "version": "0.0.1"
}

验证码

GET /api/captcha HTTP/1.1
  • Response 
    {
  "captcha": "captchaId",
  "image": "imageFileId"
}

文件资源

GET /api/file/:fileId HTTP/1.1
  • Response
    • Binary File Data

文件上传

POST /api/file HTTP/1.1
Content-Type: multipart/form-data

  • Data

    • Binary File Data

  • Response

    {
  "id": "id"
}

用户 /api/user

注册

POST /api/user/register HTTP/1.1
Content-Type: application/json
  • Data 
    {
  "username": "username",
  "password": "password",
  "email": "email",
  "phone": "phone",
  "captcha": "captchaId",
  "code": "code"
}
  • Response 
    {
  "id": "id",
  "username": "username",
  "token": "token"
}

登录

POST /api/user/login HTTP/1.1
Content-Type: application/json
  • Data 
    {
  "username": "username",
  "password": "password",
  "captcha": "captchaId",
  "code": "code"
}
  • Response 
    {
  "id": "id",
  "username": "username",
  "token": "token"
}

创建的社团列表

GET /api/user/societies/creator HTTP/1.1
Authorization: Bearer token
Accept: application/json
  • Response 
    [
  {
    "id": "id",
    "name": "name",
    "description": "description",
    "logo": "logoFileId",
    "status": "status"
  }
]

管理的社团列表

GET /api/user/societies/manager HTTP/1.1
Authorization: Bearer token
Accept: application/json
  • Response 
    [
  {
    "id": "id",
    "name": "name",
    "description": "description",
    "logo": "logoFileId",
    "status": "status"
  }
]

加入的社团列表

GET /api/user/societies/joined HTTP/1.1
Authorization: Bearer token
Accept: application/json
  • Response 
    [
  {
    "id": "id",
    "name": "name",
    "description": "description",
    "logo": "logoFileId",
    "status": "status"
  }
]

申请创建社团

POST /api/user/societies/create HTTP/1.1
Authorization: Bearer token
Accept: application/json

  • Data

    {
    "id": "societyId",
    "name": "societyName",
    "description": "description",
    "logo": "logoFileId"
}

  • Response

    {
    "id": "societyId"
}

申请加入社团

POST /api/user/societies/join HTTP/1.1
Authorization: Bearer token
Accept: application/json

  • Data

    {
    "id": "societyId"
}

  • Response

    {
    "id": "societyId"
}

社团服务中心 /api/society

员工列表

添加员工

删除员工

修改员工

添加社团

删除社团

审核社团

审核活动

用户 /api/society/user

社团 /api/societies/:societyId

成员列表

添加成员

删除成员

设置管理员

申请列表

同意申请

拒绝申请

创建活动

用户 /api/societies/:societyId/user

Clone this wiki locally