API.md

title	language_tabs	toc_footers	includes	search	code_clipboard	highlight_theme	headingLevel	generator
ibloger	shell Shell http HTTP javascript JavaScript ruby Ruby python Python php PHP java Java go Go			true	true	darkula	2	@tarslib/widdershins v4.0.28

ibloger

Base URLs:

Authentication

• HTTP Authentication, scheme: bearer

鉴权

POST 注册

POST /user/register

Body 请求参数

{
  "username": "string",
  "email": "string",
  "password": "string"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» username	body	string	是	none
» email	body	string	是	none
» password	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

POST 登录

POST /user/login

Body 请求参数

{
  "username": "string",
  "email": "string",
  "password": "string"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» username	body	string	是	none
» email	body	string	否	none
» password	body	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

用户功能

GET 获取用户资料

GET /user/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

PUT 更新用户资料

PUT /user/{id}

Body 请求参数

{
  "phoneNumber": "string",
  "email": "string",
  "password": "string",
  "nickname": "string",
  "avatarUrl": "string",
  "description": "string"
}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
body	body	object	否	none
» phoneNumber	body	string	否	none
» email	body	string	否	none
» password	body	string	否	none
» nickname	body	string	否	none
» avatarUrl	body	string	否	none
» description	body	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET 获取用户列表

GET /user

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

分类

GET 获取所有分类

GET /categories

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

POST 创建分类

POST /categories

Body 请求参数

{
  "name": "string",
  "slug": "string",
  "description": "string"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» name	body	string	是	none
» slug	body	string	是	none
» description	body	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET 获取分类信息

GET /categories/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

PATCH 更新分类

PATCH /categories/{id}

Body 请求参数

{
  "name": "string",
  "slug": "string",
  "description": "string"
}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
body	body	object	否	none
» name	body	string	是	none
» slug	body	string	是	none
» description	body	string	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

DELETE 删除分类

DELETE /categories/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

文章

POST 新建文章

POST /article

Body 请求参数

{
  "title": "string",
  "slug": "string",
  "subtitle": "string",
  "coverImage": "string",
  "content": "string",
  "isPublished": true,
  "categoryId": 0
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» title	body	string	是	none
» slug	body	string	是	none
» subtitle	body	string	否	none
» coverImage	body	string	否	none
» content	body	string	是	none
» isPublished	body	boolean	否	none
» categoryId	body	integer	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET 获取文章列表

GET /article

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

GET 获取文章

GET /article/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

PATCH 修改文章

PATCH /article/{id}

Body 请求参数

{
  "title": "string",
  "slug": "string",
  "subtitle": "string",
  "coverImage": "string",
  "content": "string",
  "isPublished": true,
  "categoryId": 0
}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
body	body	object	否	none
» title	body	string	否	none
» slug	body	string	否	none
» subtitle	body	string	否	none
» coverImage	body	string	否	none
» content	body	string	否	none
» isPublished	body	boolean	否	none
» categoryId	body	integer	否	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

DELETE 删除文章

DELETE /article/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

数据模型