comm: swagger doc
This commit is contained in:
fallen-angle
234
docs/docs.go
234
docs/docs.go
@@ -1,10 +1,10 @@
|
||||
// Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
|
||||
// Package docs GENERATED BY SWAG; DO NOT EDIT
|
||||
// This file was generated by swaggo/swag
|
||||
package docs
|
||||
|
||||
import "github.com/swaggo/swag"
|
||||
|
||||
const docTemplate_swagger = `{
|
||||
const docTemplate = `{
|
||||
"schemes": {{ marshal .Schemes }},
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
@@ -70,7 +70,6 @@ const docTemplate_swagger = `{
|
||||
},
|
||||
"/article/list": {
|
||||
"get": {
|
||||
"description": "Admin can get not published article",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
@@ -81,12 +80,60 @@ const docTemplate_swagger = `{
|
||||
"Article"
|
||||
],
|
||||
"summary": "get all articles",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/utils.GinResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/models.ListArticle"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/article/list/{published}": {
|
||||
"get": {
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"Article"
|
||||
],
|
||||
"summary": "get user's articles",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "token",
|
||||
"name": "Token",
|
||||
"in": "header"
|
||||
},
|
||||
{
|
||||
"enum": [
|
||||
"published",
|
||||
"notpublished"
|
||||
],
|
||||
"type": "string",
|
||||
"description": "string enums",
|
||||
"name": "published",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
@@ -126,14 +173,8 @@ const docTemplate_swagger = `{
|
||||
"tags": [
|
||||
"Article"
|
||||
],
|
||||
"summary": "get all articles",
|
||||
"summary": "get an articles",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "token",
|
||||
"name": "Token",
|
||||
"in": "header"
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "id",
|
||||
@@ -211,7 +252,7 @@ const docTemplate_swagger = `{
|
||||
"tags": [
|
||||
"Article"
|
||||
],
|
||||
"summary": "get all articles",
|
||||
"summary": "publish an articles",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
@@ -506,6 +547,34 @@ const docTemplate_swagger = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"/user/code/{email}": {
|
||||
"get": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"User"
|
||||
],
|
||||
"summary": "send verify code",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "email",
|
||||
"name": "email",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/utils.GinResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/user/code/{email}/{code}": {
|
||||
"get": {
|
||||
"produces": [
|
||||
@@ -601,13 +670,25 @@ const docTemplate_swagger = `{
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/utils.GinResponse"
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/utils.GinResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/models.BackUser"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/user/registers": {
|
||||
"/user/registers/{approved}": {
|
||||
"get": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
@@ -623,32 +704,15 @@ const docTemplate_swagger = `{
|
||||
"name": "Token",
|
||||
"in": "header",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/utils.GinResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/user/{code}": {
|
||||
"get": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"User"
|
||||
],
|
||||
"summary": "send verify code",
|
||||
"parameters": [
|
||||
},
|
||||
{
|
||||
"enum": [
|
||||
"approved",
|
||||
"notapproved"
|
||||
],
|
||||
"type": "string",
|
||||
"description": "email",
|
||||
"name": "email",
|
||||
"description": "string enums",
|
||||
"name": "approved",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
@@ -742,7 +806,7 @@ const docTemplate_swagger = `{
|
||||
},
|
||||
"createUser": {
|
||||
"description": "文章创建者id",
|
||||
"type": "string"
|
||||
"type": "integer"
|
||||
},
|
||||
"isDelete": {
|
||||
"description": "删除标志",
|
||||
@@ -758,7 +822,7 @@ const docTemplate_swagger = `{
|
||||
},
|
||||
"modifyUser": {
|
||||
"description": "文章最后更新者id",
|
||||
"type": "string"
|
||||
"type": "integer"
|
||||
},
|
||||
"resume": {
|
||||
"description": "文章简述",
|
||||
@@ -774,6 +838,58 @@ const docTemplate_swagger = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.BackUser": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"approver": {
|
||||
"description": "注册审核人ID",
|
||||
"type": "integer"
|
||||
},
|
||||
"aptitude": {
|
||||
"description": "用户资质证明(图片URL)",
|
||||
"type": "string"
|
||||
},
|
||||
"createTime": {
|
||||
"description": "用户注册时间",
|
||||
"type": "string"
|
||||
},
|
||||
"email": {
|
||||
"description": "用户邮箱",
|
||||
"type": "string"
|
||||
},
|
||||
"id": {
|
||||
"description": "用户ID",
|
||||
"type": "integer"
|
||||
},
|
||||
"isDelete": {
|
||||
"description": "删除标志",
|
||||
"type": "integer"
|
||||
},
|
||||
"modifyTime": {
|
||||
"type": "string"
|
||||
},
|
||||
"password": {
|
||||
"description": "用户密码",
|
||||
"type": "string"
|
||||
},
|
||||
"phone": {
|
||||
"description": "用户手机号码",
|
||||
"type": "string"
|
||||
},
|
||||
"region": {
|
||||
"description": "用户所属地域",
|
||||
"type": "string"
|
||||
},
|
||||
"role": {
|
||||
"description": "用户角色",
|
||||
"type": "integer"
|
||||
},
|
||||
"username": {
|
||||
"description": "用户真实姓名",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.ChinaAdd": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -870,6 +986,32 @@ const docTemplate_swagger = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.ListArticle": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cover": {
|
||||
"type": "string"
|
||||
},
|
||||
"createTime": {
|
||||
"type": "string"
|
||||
},
|
||||
"modifyTime": {
|
||||
"type": "string"
|
||||
},
|
||||
"resume": {
|
||||
"type": "string"
|
||||
},
|
||||
"tags": {
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"type": "string"
|
||||
},
|
||||
"username": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.UserApprove": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@@ -921,6 +1063,12 @@ const docTemplate_swagger = `{
|
||||
"phone": {
|
||||
"type": "string"
|
||||
},
|
||||
"region": {
|
||||
"type": "string"
|
||||
},
|
||||
"role": {
|
||||
"type": "integer"
|
||||
},
|
||||
"username": {
|
||||
"type": "string"
|
||||
}
|
||||
@@ -939,8 +1087,8 @@ const docTemplate_swagger = `{
|
||||
}
|
||||
}`
|
||||
|
||||
// SwaggerInfo_swagger holds exported Swagger Info so clients can modify it
|
||||
var SwaggerInfo_swagger = &swag.Spec{
|
||||
// SwaggerInfo holds exported Swagger Info so clients can modify it
|
||||
var SwaggerInfo = &swag.Spec{
|
||||
Version: "1.0",
|
||||
Host: "",
|
||||
BasePath: "",
|
||||
@@ -948,9 +1096,9 @@ var SwaggerInfo_swagger = &swag.Spec{
|
||||
Title: "nCov Tracker",
|
||||
Description: "",
|
||||
InfoInstanceName: "swagger",
|
||||
SwaggerTemplate: docTemplate_swagger,
|
||||
SwaggerTemplate: docTemplate,
|
||||
}
|
||||
|
||||
func init() {
|
||||
swag.Register(SwaggerInfo_swagger.InstanceName(), SwaggerInfo_swagger)
|
||||
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user