📰
imarket校园集市
  • Welcome
  • Introduce(简介)
  • Getting Started
    • Quickstart(快速开始)
  • API
    • 安全认证
    • Auth(认证与授权)
    • Account(账户管理)
    • Admin(管理员功能)
    • Post(帖子管理)
    • User(用户相关)
    • Comments(评论管理)
    • Message(站内消息)
    • Image(图片管理)
    • Search(搜索功能)
  • Plugin
    • Introduce(插件系统简介)
    • Start(快速上手)
    • Dependency Injection(依赖注入)
    • API (状态接口)
  • Database
    • Tables(数据库表结构)
    • create_tables_script(数据库创建脚本)
Powered by GitBook
On this page
  • GET /api/Admin/CreateCategories
  • GET /api/Admin/EditCategories
  • GET /api/Admin/DeleteCategories
  • GET /api/Admin/ListUsers
  • GET /api/Admin/BanUser
  • GET /api/Admin/UnbanUser
  • POST /api/Admin/CreateUser
  • POST /api/Admin/EditUser
  • GET /api/Admin/DeleteUser
  • GET /api/Admin/DeletePosts
  1. API

Admin(管理员功能)

GET /api/Admin/CreateCategories

  • 描述: 创建分类。

  • 参数:

    • name (string, required): 分类名称

    • description (string, required): 分类描述

  • 响应: 200 OK

请求示例

//api/Admin/CreateCategories?name=<string>&description=<string>

示例代码

const myHeaders = new Headers();
myHeaders.append("Authorization", "<API Key>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("//api/Admin/CreateCategories?name=<string>&description=<string>", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

返回示例

{
  "success": true
}

GET /api/Admin/EditCategories

  • 描述: 编辑分类。

  • 参数:

    • id (string, required): 分类ID

    • name (string, required): 分类名称

    • description (string, required): 分类描述

  • 响应: 200 OK

请求示例

//api/Admin/EditCategories?id=<string>&name=<string>&description=<string>

示例代码

const myHeaders = new Headers();
myHeaders.append("Authorization", "<API Key>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("//api/Admin/EditCategories?id=<string>&name=<string>&description=<string>", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

返回示例

{
  "success": true
}

GET /api/Admin/DeleteCategories

  • 描述: 删除分类。

  • 参数:

    • id (string, required): 分类ID

  • 响应: 200 OK

请求示例

//api/Admin/DeleteCategories?id=<ulong>

示例代码

const myHeaders = new Headers();
myHeaders.append("Authorization", "<API Key>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("//api/Admin/DeleteCategories?id=<ulong>", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

返回示例

{
  "success": true
}

GET /api/Admin/ListUsers

  • 描述: 列出用户。

  • 参数:

    • page (integer, optional, default=1): 页码

    • pageSize (integer, optional, default=10): 每页大小

  • 响应: 200 OK

请求示例

//api/Admin/ListUsers?page=1&pageSize=10

示例代码

const myHeaders = new Headers();
myHeaders.append("Authorization", "<API Key>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("//api/Admin/ListUsers?page=1&pageSize=10", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

返回示例

{
  "success": true,
  "users": [
    {
      "id": 1,
      "username": "alibb",
      "nickname": "风中的笑脸",
      "avatar": "/images/defaultAvatar.png",
      "email": "dwdwafef",
      "passwordHash": "66ebb3e1ed156a03801ecf5c40320bd8a3720f07d65612c486fd7b65ac268135",
      "role": "user",
      "createdAt": "2025-01-22T15:50:48",
      "status": 0
    },
    {
      "id": 2,
      "username": "admin",
      "nickname": "admin imarket",
      "avatar": "test",
      "email": "imarket@imarket.com",
      "passwordHash": "66ebb3e1ed156a03801ecf5c40320bd8a3720f07d65612c486fd7b65ac268135",
      "role": "admin",
      "createdAt": "2025-01-19T15:33:23",
      "status": 1
    }
  ]
}

GET /api/Admin/BanUser

  • 描述: 封禁用户。

  • 参数:

    • id (string): 用户ID

  • 响应: 200 OK

请求示例

//api/Admin/BanUser?id=<ulong>

示例代码

const myHeaders = new Headers();
myHeaders.append("Authorization", "<API Key>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("//api/Admin/BanUser?id=<ulong>", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

返回示例

{
  "success": true
}

GET /api/Admin/UnbanUser

  • 描述: 解封用户。

  • 参数:

    • id (string, required): 用户ID

  • 响应: 200 OK

请求示例

//api/Admin/UnbanUser?id=<ulong>

示例代码

const myHeaders = new Headers();
myHeaders.append("Authorization", "<API Key>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("//api/Admin/UnbanUser?id=<ulong>", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

返回示例

{
  "success": true
}

POST /api/Admin/CreateUser

  • 描述: 创建用户。

  • 请求体:

    • application/json: UserCreateRequest 对象

    • text/json: UserCreateRequest 对象

    • application/*+json: UserCreateRequest 对象

  • 响应: 200 OK

请求示例

{
  "email": "<string>",
  "nickname": "<string>",
  "passwordHash": "<string>",
  "role": "<string>",
  "username": "<string>",
  "avatar": "<string>",
  "status": "<integer>"
}

示例代码

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "<API Key>");

const raw = JSON.stringify({
  "email": "<string>",
  "nickname": "<string>",
  "passwordHash": "<string>",
  "role": "<string>",
  "username": "<string>",
  "avatar": "<string>",
  "status": "<integer>"
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("//api/Admin/CreateUser", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

返回示例

{
  "success": true
}

POST /api/Admin/EditUser

  • 描述: 编辑用户信息。

  • 请求体:

    • application/json: UserEditRequest 对象

    • text/json: UserEditRequest 对象

    • application/*+json: UserEditRequest 对象

  • 响应: 200 OK

请求示例

{
  "id": "<ulong>",
  "nickname": "<string>",
  "avatar": "<string>",
  "email": "<string>",
  "role": "<string>",
  "status": "<integer>"
}

示例代码

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "<API Key>");

const raw = JSON.stringify({
  "id": "<string>",
  "nickname": "<string>",
  "avatar": "<string>",
  "email": "<string>",
  "role": "<string>",
  "status": "<integer>"
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("//api/Admin/EditUser", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

返回示例

{
  "success": true
}

GET /api/Admin/DeleteUser

  • 描述: 删除用户。

  • 参数:

    • userId (string, required): 用户ID

  • 响应: 200 OK

请求示例

//api/Admin/DeleteUser?userId=<ulong>

示例代码

const myHeaders = new Headers();
myHeaders.append("Authorization", "<API Key>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("//api/Admin/DeleteUser?userId=<ulong>", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

返回示例

{
  "success": true
}

GET /api/Admin/DeletePosts

  • 描述: 删除帖子。

  • 参数:

    • userId (string, required): 用户ID

  • 响应: 200 OK

请求示例

//api/Admin/DeletePosts?userId=<ulong>

示例代码

const myHeaders = new Headers();
myHeaders.append("Authorization", "<API Key>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("//api/Admin/DeletePosts?userId=<ulong>", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

返回示例

{
  "success": true
}
PreviousAccount(账户管理)NextPost(帖子管理)

Last updated 3 months ago