Back to Springboot Learning

Paths

2.x/chapter2-5/src/docs/markdown/generated/paths.md

latest3.0 KB
Original Source

<a name="paths"></a>

Paths

<a name="postuserusingpost"></a>

创建用户

POST /users/

Description

根据User对象创建用户

Parameters

TypeNameDescriptionSchema
Bodyuser
requireduserUser

Responses

HTTP CodeDescriptionSchema
200OKstring
201CreatedNo Content
401UnauthorizedNo Content
403ForbiddenNo Content
404Not FoundNo Content

Consumes

  • application/json

Produces

  • \*/*

Tags

  • 用户管理

Security

TypeNameScopes
apiKeyAuthorizationglobal

<a name="getuserlistusingget"></a>

获取用户列表

GET /users/

Responses

HTTP CodeDescriptionSchema
200OK< User > array
401UnauthorizedNo Content
403ForbiddenNo Content
404Not FoundNo Content

Produces

  • \*/*

Tags

  • 用户管理

Security

TypeNameScopes
apiKeyAuthorizationglobal

<a name="getuserusingget"></a>

获取用户详细信息

GET /users/{id}

Description

根据url的id来获取用户详细信息

Parameters

TypeNameDescriptionSchema
Pathid
requiredidinteger (int64)

Responses

HTTP CodeDescriptionSchema
200OKUser
401UnauthorizedNo Content
403ForbiddenNo Content
404Not FoundNo Content

Produces

  • \*/*

Tags

  • 用户管理

Security

TypeNameScopes
apiKeyAuthorizationglobal

<a name="putuserusingput"></a>

更新用户详细信息

PUT /users/{id}

Description

根据url的id来指定更新对象,并根据传过来的user信息来更新用户详细信息

Parameters

TypeNameDescriptionSchema
Pathid
required用户编号integer (int64)
Bodyuser
requireduserUser

Responses

HTTP CodeDescriptionSchema
200OKstring
201CreatedNo Content
401UnauthorizedNo Content
403ForbiddenNo Content
404Not FoundNo Content

Consumes

  • application/json

Produces

  • \*/*

Tags

  • 用户管理

Security

TypeNameScopes
apiKeyAuthorizationglobal

<a name="deleteuserusingdelete"></a>

删除用户

DELETE /users/{id}

Description

根据url的id来指定删除对象

Parameters

TypeNameDescriptionSchema
Pathid
requiredidinteger (int64)

Responses

HTTP CodeDescriptionSchema
200OKstring
204No ContentNo Content
401UnauthorizedNo Content
403ForbiddenNo Content

Produces

  • \*/*

Tags

  • 用户管理

Security

TypeNameScopes
apiKeyAuthorizationglobal