Skip to content

Nick233333/gin-restful-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API 文档

响应数据示例:

{
    "code": xx,
    "data": xx,
    "msg": "xx"
}

登录接口 url : /auth 请求方法:POST 请求参数:

参数名 类型 是否必传 说明
username string 用户名
password string 密码

备注: 无


上传图片接口 url : /upload 请求方法:POST 请求参数:

参数名 类型 是否必传 说明
image string 图片名称

备注: 无


获取标签列表接口 url : /api/v1/tags 请求方法:GET 请求参数:

参数名 类型 是否必传 说明
name string 标签名
state int 状态

请求头:

名称 类型 是否必传 说明
token string jwt token

备注: 无


新建标签接口 url : /api/v1/tags 请求方法:POST 请求参数:

参数名 类型 是否必传 说明
name string 标签名
created_by string 创建人
state int 状态

请求头:

名称 类型 是否必传 说明
token string jwt token

备注: 无


更新标签接口 url : /api/v1/tags/:id 请求方法:PUT 请求参数:

参数名 类型 是否必传 说明
id int id
name string 标签名
modified_by string 修改人
state int 状态

请求头:

名称 类型 是否必传 说明
token string jwt token

备注: 无


删除标签接口 url : /api/v1/tags/:id 请求方法:DELETE 请求参数:

参数名 类型 是否必传 说明
id int id

请求头:

名称 类型 是否必传 说明
token string jwt token

备注: 无


文章列表接口 url : /api/v1/articles 请求方法:GET 请求参数:

参数名 类型 是否必传 说明
tag_id int 标签id
state int 状态

请求头:

名称 类型 是否必传 说明
token string jwt token

备注: 无


获取单个文章接口 url : /api/v1/articles/:id 请求方法:GET 请求参数:

参数名 类型 是否必传 说明
id int id

请求头:

名称 类型 是否必传 说明
token string jwt token

备注: 无


新建文章列表接口 url : /api/v1/articles 请求方法:POST 请求参数:

参数名 类型 是否必传 说明
tag_id int 标签id
title string 文章标题
desc string 简介
content string 内容
created_by string 创建人
state int 状态
image_url string 图片地址

请求头:

名称 类型 是否必传 说明
token string jwt token

备注: 无


更新文章接口 url : /api/v1/articles/:id 请求方法:PUT 请求参数:

参数名 类型 是否必传 说明
id int id
tag_id int 标签id
modified_by string 修改人
title string 文章标题
desc string 简介
content string 内容
state int 状态
image_url string 图片地址

请求头:

名称 类型 是否必传 说明
token string jwt token

备注: 无


删除文章接口 url : /api/v1/articles/:id 请求方法:DELETE 请求参数:

参数名 类型 是否必传 说明
id int id

请求头:

名称 类型 是否必传 说明
token string jwt token

备注: 无


About

🙏gin-restful-api

http://gin-api.hellocode.name

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages