Golang gin开源实例——接口

Github地址

https://github.com/EDDYCJY/go-gin-example

返回值

字段：code、msg、data

举例

# 失败
{
    "code": 10001,
    "msg": "已存在该标签名称",
    "data": null
}

#成功
{
    "code": 200,
    "msg": "ok",
    "data": null
}

接口列表

模块	接口	功能	协议	参数	返回值	示例	问题-备注
认证	/auth		GET	username password		{"code":200,"msg":"ok","data":{"token":"eyJhbGd24ciO"}}	apiv1.Use(jwt.JWT())  使用jwt身份验证时，每个接口访问是都需要加上token验证
	/swagger/index.html	自动生成接口文档	GET				安装: go get *** 生成：swag init 访问：http://127.0.0.1:8080/swagger/index.html 类型不识别// @Param file body file true "Excel File"
	/upload		POST				?
标签	/api/v1/tags	获取	GET	name state		{ "code": 200, "msg": "ok", "data": { "lists": [{ "id": 4, "created_on": 1580484919, "modified_on": 1580484919, "deleted_on": 0, "name": "tag1", "created_by": "jihite", "modified_by": "", "state": 0 }], "total": 1 } }	modle 与 db table 如何关联
	/api/v1/tags	添加	POST	name created_by state		{ "code": 200, "msg": "ok", "data": null }
	/api/v1/tags/id	修改	PUT	name modified_by state
	/api/v1/tags/id	删除	DELETE
	/tags/export	导出	POST	name state
	/tags/import	导入	POST	file文件
文件	/api/v1/articles	列表	GET	state tag_id			传入参数，因是post获取，无法解析
	/api/v1/articles/id	指定列表	GET
	/api/v1/articles	新建	POST	tag_id title desc content created_by state cover_image_url		{ "code": 200, "msg": "ok", "data": null }	校验参数如何关联的？ [通过form]
	/api/v1/articles/id	更新	PUT	id  tag_id title desc content modified_by state cover_image_url			有必要传所有参数吗？
	/api/v1/articles/id	删除	DELETE			{ "code": 200, "msg": "ok", "data": null }	删除了deleted_on赋值，不物理删除
	/api/v1/articles/poster/generate	生成海报	POST