1. Overview

ITMuch API

1.1. Version information

Version : 1.0.0

1.2. URI scheme

Host : localhost:8080
BasePath : /

1.3. Tags

  • 公告相关接口 : 公告相关接口

  • 分享相关接口 : 分享相关接口

  • 用户相关接口 : 用户相关接口

  • 管理员相关接口 : 管理员相关接口

2. Resources

2.1. 公告相关接口

公告相关接口

2.1.1. 查询最新的一条公告

GET /notices/newest
Description

用于:公告

Responses
HTTP Code Description Schema

200

OK

公告

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.2. 分享相关接口

分享相关接口

2.2.1. 投稿

POST /shares/contribute
Description

用于:投稿

Parameters
Type Name Description Schema

Body

shareRequestDTO
required

shareRequestDTO

分享信息

Responses
HTTP Code Description Schema

200

OK

分享

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

2.2.2. 编辑投稿

PUT /shares/contribute/{id}
Description

用于:投稿

Parameters
Type Name Description Schema

Path

id
required

share id

string

Body

shareRequestDTO
required

shareRequestDTO

分享信息

Responses
HTTP Code Description Schema

200

OK

分享

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

2.2.3. 积分兑换指定ID的share

GET /shares/exchange/{id}
Description

用于:首页-兑换-兑换

Parameters
Type Name Description Schema

Path

id
required

share id

integer (int64)

Responses
HTTP Code Description Schema

200

OK

分享

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.2.4. 查询当前登录用户拥有的share列表

GET /shares/my
Description

用于:我的-我的兑换

Responses
HTTP Code Description Schema

200

OK

< 分享 > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.2.5. 我的投稿

GET /shares/my/contributions
Description

用于:我的-我的投稿

Responses
HTTP Code Description Schema

200

OK

< 分享 > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.2.6. 根据id预览详情

GET /shares/preview/{id}
Description

用于:投稿-提交投稿-预览

Parameters
Type Name Description Schema

Path

id
required

share id

integer (int32)

Responses
HTTP Code Description Schema

200

OK

分享

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.2.7. 根据title分页like查询share

GET /shares/q
Description

用于:首页-搜索框

Parameters
Type Name Description Schema

Query

pageNo
optional

页码

integer (int32)

Query

pageSize
optional

每页显示多少条

integer (int32)

Body

title
optional

标题

string

Responses
HTTP Code Description Schema

200

OK

PageInfo

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.2.8. 根据id查询详情

GET /shares/{id}
Description

用于:首页-兑换/下载-详情

Parameters
Type Name Description Schema

Path

id
required

share id

integer (int32)

Responses
HTTP Code Description Schema

200

OK

分享信息,带发布人昵称

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.3. 用户相关接口

用户相关接口

2.3.1. 查询当前登录用户积分明细

GET /users/bonus-logs
Description

用于:我的-积分明细

Responses
HTTP Code Description Schema

200

OK

< 积分明细 > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.3.2. 登录

POST /users/login
Description

用于:登录

Parameters
Type Name Description Schema

Body

loginDTO
required

loginDTO

用户登录信息

Responses
HTTP Code Description Schema

200

OK

登录响应DTO

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

2.3.3. 查询当前登录用户的个人信息

GET /users/me
Description

用于:我的-个人信息展示

Responses
HTTP Code Description Schema

200

OK

用户

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.3.4. 签到

GET /users/sign
Description

用于:我的-签到

Responses
HTTP Code Description Schema

200

OK

用户

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.3.5. 根据id,查询指定用户的信息

GET /users/{id}
Description

用于:首页-兑换/下载-详情

Parameters
Type Name Description Schema

Path

id
required

id

integer (int32)

Responses
HTTP Code Description Schema

200

OK

用户

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.4. 管理员相关接口

管理员相关接口

2.4.1. 审核指定内容

PUT /admin/shares/audit/{id}
Description

管理员才能使用

Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)

Body

auditDTO
required

auditDTO

分享审核DTO

Responses
HTTP Code Description Schema

200

OK

分享

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

3. Definitions

3.1. PageInfo

Name Schema

endRow
optional

integer (int32)

hasNextPage
optional

boolean

hasPreviousPage
optional

boolean

isFirstPage
optional

boolean

isLastPage
optional

boolean

list
optional

< object > array

navigateFirstPage
optional

integer (int32)

navigateLastPage
optional

integer (int32)

navigatePages
optional

integer (int32)

navigatepageNums
optional

< integer (int32) > array

nextPage
optional

integer (int32)

pageNum
optional

integer (int32)

pageSize
optional

integer (int32)

pages
optional

integer (int32)

prePage
optional

integer (int32)

size
optional

integer (int32)

startRow
optional

integer (int32)

total
optional

integer (int64)

3.2. 公告

Name Description Schema

content
optional

公告内容

string

createTime
optional

创建时间

string (date-time)

id
optional

id

integer (int32)

showFlag
optional

是否显示

boolean

3.3. 分享

Name Description Schema

auditStatus
optional

审核状态(NOT_YET:待审核,PASS:通过,REJECT:拒绝)

string

author
optional

作者

string

buyCount
optional

购买次数

integer (int32)

cover
optional

封面地址

string

createTime
optional

创建时间

string (date-time)

downloadUrl
optional

下载地址

string

id
optional

id

integer (int32)

isOriginal
optional

是否原创

boolean

price
optional

价格

integer (int32)

reason
optional

审核不通过的原因

string

showFlag
optional

是否展示

boolean

summary
optional

简介

string

title
optional

标题

string

updateTime
optional

修改时间

string (date-time)

userId
optional

发布人ID

string

3.4. 分享信息

Name Description Schema

author
required

作者

string

downloadUrl
required

下载地址

string

isOriginal
required

是否原创

boolean

price
required

价格

integer (int32)

summary
required

简介

string

title
required

标题

string

3.5. 分享信息,带发布人昵称

Name Description Schema

auditStatus
optional

审核状态

enum (NOT_YET, PASS, REJECT)

author
optional

作者

string

buyCount
optional

购买次数

integer (int32)

cover
optional

封面地址

string

createTime
optional

创建时间

string (date-time)

downloadUrl
optional

下载地址

string

id
optional

id

integer (int32)

isOriginal
optional

是否原创

boolean

price
optional

价格

integer (int32)

reason
optional

审核不通过的原因

string

show
optional

是否展示

boolean

summary
optional

简介

string

title
optional

标题

string

type
optional

类型(分类)

string

updateTime
optional

修改时间

string (date-time)

wxNickname
optional

发布人昵称

string

3.6. 分享审核DTO

Name Description Schema

auditStatusEnum
required

审核状态

enum (NOT_YET, PASS, REJECT)

reason
required

原因

string

3.7. 用户

Name Description Schema

avatarUrl
optional

头像地址

string

bonus
optional

积分

integer (int32)

createTime
optional

创建时间

string (date-time)

id
optional

id

integer (int32)

roles
optional

角色

< string > array

updateTime
optional

修改时间

string (date-time)

wxId
optional

微信的open_id,用于微信登录

string

wxNickname
optional

微信昵称

string

3.8. 用户响应DTO

Name Description Schema

avatarUrl
optional

头像地址

string

bonus
optional

积分

integer (int32)

id
optional

id

integer (int32)

wxNickname
optional

微信昵称

string

3.9. 用户登录信息

Name Description Schema

avatarUrl
required

头像地址

string

code
required

code

string

wxNickname
required

微信昵称

string

3.10. 登录响应

Name Description Schema

expirationTime
required

过期时间

integer (int64)

token
required

token

string

3.11. 登录响应DTO

Name Description Schema

token
required

token信息

登录响应

user
required

用户信息

用户响应DTO

3.12. 积分明细

Name Description Schema

createTime
optional

时间

string (date-time)

description
optional

详细描述

string

event
optional

事件

string

id
optional

id

integer (int32)

userId
optional

用户ID

string

value
optional

积分值

integer (int32)