Smart Campus

https://github.com/xingly-cn/smart-campus
Admin
Smart Campus is a comprehensive campus service platform that provides lost-and-found, campus...
Tokens:6,432
Snippets:52
Trust Score:5.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### GET /lost/school/getList

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Retrieves a paginated list of schools.

```APIDOC
## GET /lost/school/getList

### Description
Retrieves a paginated list of schools.

### Method
GET

### Endpoint
http://localhost:8080/lost/school/getList

### Parameters
#### Query Parameters
- **cur** (integer) - Required - Current page
- **size** (integer) - Required - Page size

### Response
#### Success Response (200)
- **schoolList** (array) - List of schools
- **total** (integer) - Total count
```

--------------------------------

### Get Student Information

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Retrieves current logged-in student details using a JWT token or by student ID. Includes personal information and verification status.

```bash
# 获取当前登录学生信息
curl -X GET "http://localhost:8080/lost/stu/getInfo" \
  -H "token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
```

```bash
# 根据学生ID获取信息
curl -X GET "http://localhost:8080/lost/stu/getInfo2?stuId=1234567890"
```

```json
# 响应示例
{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "stu": {
      "id": "1234567890",
      "name": "张三",
      "username": "student001",
      "phone": "13800138000",
      "avatar": "https://example.com/avatar.jpg",
      "email": "student@example.com",
      "schoolname": "清华大学",
      "gender": 1,
      "createtime": "2022-02-10T08:00:00",
      "lastlogin": "2022-02-15T10:30:00",
      "verify": 1
    }
  }
}
```

--------------------------------

### GET /lost/stu/getInfo

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Retrieves the profile information of the currently logged-in student using a JWT token.

```APIDOC
## GET /lost/stu/getInfo

### Description
Retrieves the profile information of the currently logged-in student using a JWT token.

### Method
GET

### Endpoint
/lost/stu/getInfo

### Parameters
#### Header Parameters
- **token** (string) - Required - JWT authentication token

### Response
#### Success Response (200)
- **stu** (object) - Student profile details

#### Response Example
{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "stu": {
      "id": "1234567890",
      "name": "张三",
      "username": "student001",
      "phone": "13800138000",
      "schoolname": "清华大学"
    }
  }
}
```

--------------------------------

### GET /lost/category/getList

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Retrieves a list of all lost and found categories.

```APIDOC
## GET /lost/category/getList

### Description
Retrieves a list of all lost and found categories.

### Method
GET

### Endpoint
http://localhost:8080/lost/category/getList

### Response
#### Success Response (200)
- **list** (array) - List of categories

#### Response Example
{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "list": [
      {
        "id": "1",
        "name": "证件",
        "description": "身份证、学生证、校园卡等",
        "level": 10,
        "count": 150,
        "find": 120
      }
    ]
  }
}
```

--------------------------------

### Get Member ID from JWT Token

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Extract the member ID from a JWT token contained within an HttpServletRequest using JwtUtils. Ensure the token is valid before extraction.

```java
import com.sugar.base.utils.JwtUtils;

// 从 Request 中获取用户ID
String userId = JwtUtils.getMemberIdByJwtToken(request);
// 返回: "userId123"
```

--------------------------------

### Manage Schools

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Endpoints for listing, retrieving details, and adding schools to the platform.

```bash
curl -X GET "http://localhost:8080/lost/school/getList?cur=1&size=10"
```

```bash
curl -X GET "http://localhost:8080/lost/school/getInfo?schoolId=1"
```

```bash
curl -X POST "http://localhost:8080/lost/school/add" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "复旦大学"
  }'
```

--------------------------------

### Student Login and Auto-Registration

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Initiates student login. If the student does not exist, an account is automatically created. Requires username and password.

```bash
# 学生登录（首次登录自动注册）
curl -X POST "http://localhost:8080/lost/stu/login" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "student001",
    "password": "123456"
  }'
```

```json
# 响应示例
{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }
}
```

--------------------------------

### Manage Announcements

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Endpoints for retrieving and adding platform announcements.

```bash
curl -X GET "http://localhost:8080/lost/inform/getList?cur=1&size=10"
```

```bash
curl -X GET "http://localhost:8080/lost/inform/getInfo?categoryId=notice"
```

```bash
curl -X POST "http://localhost:8080/lost/inform/add" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "系统维护通知",
    "content": "系统将于2022年2月20日凌晨2:00-4:00进行维护升级",
    "categoryid": "system"
  }'
```

--------------------------------

### Student Verification Process

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Handles student verification through a two-step process: sending a verification code and then submitting it for validation. The code is valid for 5 minutes and stored in Redis.

```bash
# 发送认证码
curl -X POST "http://localhost:8080/lost/stu/sendCode" \
  -H "token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
```

```json
# 响应示例
{
  "success": true,
  "code": 20000,
  "message": "验证码发送成功,请于5分钟内完成验证."
}
```

```bash
# 提交认证码验证
curl -X POST "http://localhost:8080/lost/stu/verify?code=abc123def456" \
  -H "token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
```

```json
# 响应示例
{
  "success": true,
  "code": 20000,
  "message": "认证成功"
}
```

--------------------------------

### POST /lost/inform/add

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Adds a new platform announcement.

```APIDOC
## POST /lost/inform/add

### Description
Adds a new platform announcement.

### Method
POST

### Endpoint
http://localhost:8080/lost/inform/add

### Parameters
#### Request Body
- **title** (string) - Required - Announcement title
- **content** (string) - Required - Announcement content
- **categoryid** (string) - Required - Category ID

### Request Example
{
  "title": "系统维护通知",
  "content": "系统将于2022年2月20日凌晨2:00-4:00进行维护升级",
  "categoryid": "system"
}
```

--------------------------------

### POST /lost/stu/login

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Authenticates a student. If it is the first login, an account is automatically registered.

```APIDOC
## POST /lost/stu/login

### Description
Authenticates a student. If it is the first login, an account is automatically registered.

### Method
POST

### Endpoint
/lost/stu/login

### Request Body
- **username** (string) - Required - Student username
- **password** (string) - Required - Student password

### Response
#### Success Response (200)
- **token** (string) - JWT authentication token

#### Response Example
{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }
}
```

--------------------------------

### Manage Messages

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Endpoints for sending, listing, viewing, and marking messages as read. Requires a valid authentication token.

```bash
curl -X POST "http://localhost:8080/lost/msg/send" \
  -H "Content-Type: application/json" \
  -H "token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -d '{
    "goodid": "9876543210",
    "stuid": "1234567890",
    "content": "您好，我在3号教学楼捡到了您丢失的校园卡，请联系我领取"
  }'
```

```bash
curl -X GET "http://localhost:8080/lost/msg/getList" \
  -H "token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
```

```bash
curl -X GET "http://localhost:8080/lost/msg/getInfo?msgId=msg001" \
  -H "token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
```

```bash
curl -X GET "http://localhost:8080/lost/msg/read?msgId=msg001" \
  -H "token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
```

--------------------------------

### Manage Feedback

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Endpoints for submitting, listing, viewing, and deleting user feedback. Listing supports both student-specific and admin-wide views.

```bash
curl -X POST "http://localhost:8080/lost/callback/add" \
  -H "Content-Type: application/json" \
  -H "token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -d '{
    "title": "功能建议",
    "content": "建议增加物品图片上传功能，方便查找"
  }'
```

```bash
curl -X GET "http://localhost:8080/lost/callback/getList?cur=1&size=10" \
  -H "token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
```

```bash
curl -X GET "http://localhost:8080/lost/callback/getList?cur=1&size=10"
```

```bash
curl -X GET "http://localhost:8080/lost/callback/getInfo?callbackId=callback001"
```

```bash
curl -X GET "http://localhost:8080/lost/callback/del?callbackId=callback001"
```

--------------------------------

### Manage Categories

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Endpoints for retrieving, adding, editing, and deleting item categories.

```bash
curl -X GET "http://localhost:8080/lost/category/getList"
```

```bash
curl -X GET "http://localhost:8080/lost/category/getInfo?categoryId=1"
```

```bash
curl -X POST "http://localhost:8080/lost/category/add" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "书籍文具",
    "description": "书本、笔记本、文具等",
    "level": 5
  }'
```

```bash
curl -X POST "http://localhost:8080/lost/category/edit" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "3",
    "name": "书籍文具",
    "description": "教材、笔记本、文具等学习用品",
    "level": 6
  }'
```

```bash
curl -X POST "http://localhost:8080/lost/category/del?categoryId=3"
```

--------------------------------

### POST /lost/callback/add

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Submits a user feedback or suggestion.

```APIDOC
## POST /lost/callback/add

### Description
Submits a user feedback or suggestion.

### Method
POST

### Endpoint
http://localhost:8080/lost/callback/add

### Parameters
#### Request Body
- **title** (string) - Required - Feedback title
- **content** (string) - Required - Feedback content

### Request Example
{
  "title": "功能建议",
  "content": "建议增加物品图片上传功能，方便查找"
}
```

--------------------------------

### Query Item Lists

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Provides endpoints to retrieve lists of lost and found items. Supports pagination, keyword search, and filtering by category. Can fetch all items or only those posted by the current user.

```bash
# 获取全部物品列表（带筛选条件）
curl -X GET "http://localhost:8080/lost/good/getAllList?cur=1&size=10&f=all" \
  -H "token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
```

```bash
# 按关键词搜索
curl -X GET "http://localhost:8080/lost/good/getAllList?cur=1&size=10&keyword=校园卡&f=all"
```

```bash
# 按分类筛选
curl -X GET "http://localhost:8080/lost/good/getAllList?cur=1&size=10&categoryId=1234567890&f=all"
```

```json
# 响应示例
{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "list": [
      {
        "id": "9876543210",
        "schoolid": "1",
        "name": "张三",
        "category": "证件",
        "title": "丢失校园卡一张",
        "content": "在图书馆二楼丢失...",
        "tags": 0,
        "look": 150,
        "createtime": "2022-02-14T14:30:00",
        "url": "https://example.com/image.jpg",
        "userId": "1234567890"
      }
    ],
    "total": 50
  }
}
```

--------------------------------

### Return Success Response

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Use the R class to construct a success response with data. The `data` method can be chained to add multiple key-value pairs.

```java
import com.sugar.base.result.R;

// 返回成功响应
return R.ok().data("user", userObject);
// 响应: {"success":true,"code":20000,"message":"成功","data":{"user":{...}}}
```

--------------------------------

### Student List Management

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Provides administrative access to view, edit, and delete student records. Supports pagination and sorting by verification status and last login time.

```bash
# 获取学生列表（分页）
curl -X GET "http://localhost:8080/lost/stu/getList?cur=1&size=10"
```

```json
# 响应示例
{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "stuList": [
      {
        "id": "1",
        "name": "张三",
        "username": "zhangsan",
        "schoolname": "清华大学",
        "verify": 1,
        "lastlogin": "2022-02-15T10:30:00"
      }
    ],
    "total": 100
  }
}
```

```bash
# 编辑学生信息
curl -X POST "http://localhost:8080/lost/stu/edit" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "1234567890",
    "name": "李四",
    "phone": "13900139000",
    "avatar": "https://example.com/new-avatar.jpg"
  }'
```

```bash
# 删除学生
curl -X POST "http://localhost:8080/lost/stu/del?stuId=1234567890"
```

--------------------------------

### Return Success Response with Multiple Data Items

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Chain multiple `data` calls on an R.ok() response to include several data fields, such as a list and a total count.

```java
import com.sugar.base.result.R;

// 返回多个数据项
return R.ok().data("list", itemList).data("total", totalCount);
// 响应: {"success":true,"code":20000,"message":"成功","data":{"list":[...],"total":100}}
```

--------------------------------

### Return Success Response with Custom Message

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Construct a success response using R.ok(), allowing for a custom message and data payload. This is useful for providing specific feedback on operations.

```java
import com.sugar.base.result.R;

// 返回带自定义消息的成功响应
return R.ok().message("操作成功").data("count", 10);
// 响应: {"success":true,"code":20000,"message":"操作成功","data":{"count":10}}
```

--------------------------------

### POST /lost/good/add

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Allows a student to publish a new lost or found item report.

```APIDOC
## POST /lost/good/add

### Description
Allows a student to publish a new lost or found item report.

### Method
POST

### Endpoint
/lost/good/add

### Parameters
#### Header Parameters
- **token** (string) - Required - JWT authentication token

#### Request Body
- **category** (string) - Required - Item category ID
- **title** (string) - Required - Item title
- **content** (string) - Required - Description of the item
- **url** (string) - Optional - Image URL

### Response
#### Success Response (200)
- **success** (boolean) - Operation status

#### Response Example
{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "success": true
  }
}
```

--------------------------------

### Post Lost and Found Item

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Allows students to publish information about lost or found items. Associates the item with the student and their school. Requires item category, title, content, and an optional image URL.

```bash
# 发布物品信息
curl -X POST "http://localhost:8080/lost/good/add" \
  -H "Content-Type: application/json" \
  -H "token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -d '{
    "category": "1234567890",
    "title": "丢失校园卡一张",
    "content": "在图书馆二楼丢失校园卡，卡号123456，如有拾获请联系我",
    "url": "https://example.com/image.jpg"
  }'
```

```json
# 响应示例
{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "success": true
  }
}
```

--------------------------------

### Item Details and Status Management

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Manages individual item postings. Viewing an item increases its view count. Allows editing item details and marking an item as found. Also includes endpoints for deleting items.

```bash
# 获取物品详情（自动增加浏览量）
curl -X GET "http://localhost:8080/lost/good/getInfo?goodId=9876543210"
```

```json
# 响应示例
{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "good": {
      "id": "9876543210",
      "name": "张三",
      "category": "证件",
      "title": "丢失校园卡一张",
      "content": "在图书馆二楼丢失校园卡，卡号123456",
      "tags": 0,
      "look": 151
    }
  }
}
```

```bash
# 编辑物品信息
curl -X POST "http://localhost:8080/lost/good/edit" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "9876543210",
    "title": "已找到-丢失校园卡一张",
    "content": "物品已找回，感谢大家"
  }'
```

```bash
# 标记物品已找到
curl -X GET "http://localhost:8080/lost/good/find?goodId=9876543210"
```

```bash
# 删除物品
curl -X GET "http://localhost:8080/lost/good/del?goodId=9876543210"
```

--------------------------------

### Generate JWT Token

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Use JwtUtils to generate a JWT token with user ID and username. The generated token is a string.

```java
import com.sugar.base.utils.JwtUtils;

// 生成 JWT Token
String token = JwtUtils.getJwtToken("userId123", "张三");
// 返回: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
```

--------------------------------

### Category Management

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Manages item categories, supporting CRUD operations. Categories are prioritized and display the count of items within each category.

--------------------------------

### Return Error Response

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Use R.error() to create a standardized error response, optionally including a custom error message. The `data` field will be empty by default.

```java
import com.sugar.base.result.R;

// 返回错误响应
return R.error().message("用户名或密码错误");
// 响应: {"success":false,"code":20001,"message":"用户名或密码错误","data":{}}
```

--------------------------------

### POST /lost/msg/send

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Sends a private message regarding a specific item.

```APIDOC
## POST /lost/msg/send

### Description
Sends a private message regarding a specific item.

### Method
POST

### Endpoint
http://localhost:8080/lost/msg/send

### Parameters
#### Request Body
- **goodid** (string) - Required - Item ID
- **stuid** (string) - Required - Student ID
- **content** (string) - Required - Message content

### Request Example
{
  "goodid": "9876543210",
  "stuid": "1234567890",
  "content": "您好，我在3号教学楼捡到了您丢失的校园卡，请联系我领取"
}
```

--------------------------------

### Validate JWT Token

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Validate a JWT token using JwtUtils. This method checks the token's validity.

```java
import com.sugar.base.utils.JwtUtils;

// 验证 Token 是否有效
boolean isValid = JwtUtils.checkToken(token);
// 返回: true
```

--------------------------------

### Validate JWT Token from Request

Source: https://context7.com/xingly-cn/smart-campus/llms.txt

Validate a JWT token directly from an HttpServletRequest object using JwtUtils. This is useful for server-side validation.

```java
import com.sugar.base.utils.JwtUtils;

// 从 HttpServletRequest 中验证 Token
boolean isValidFromRequest = JwtUtils.checkToken(request);
// 返回: true
```
Tokens:
Raw