// Package docs GENERATED BY SWAG; DO NOT EDIT // This file was generated by swaggo/swag package docs import "github.com/swaggo/swag" const docTemplate = `{ "schemes": {{ marshal .Schemes }}, "swagger": "2.0", "info": { "description": "{{escape .Description}}", "title": "{{.Title}}", "termsOfService": "http://swagger.io/terms/", "contact": { "name": "Shikong", "email": "919411476@qq.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "{{.Version}}" }, "host": "{{.Host}}", "basePath": "{{.BasePath}}", "paths": { "/": { "get": { "description": "简单的 HelloWorld 示例", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "HelloWorld" ], "summary": "HelloWorld", "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "data": { "type": "string" } } } ] } }, "default": { "description": "", "schema": { "$ref": "#/definitions/errorx.CodeErrorResponse" } } } } }, "/casbin/getUserRoles": { "get": { "description": "用户所有角色", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "CasBin" ], "summary": "用户所有角色", "parameters": [ { "type": "string", "default": "root", "description": "用户账号", "name": "account", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" } } } } ] } }, "default": { "description": "", "schema": { "$ref": "#/definitions/errorx.CodeErrorResponse" } } } } }, "/casbin/reload": { "post": { "description": "重新加载 casbin 策略", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "CasBin" ], "summary": "重新加载 casbin 策略", "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "data": { "type": "string" } } } ] } }, "default": { "description": "", "schema": { "$ref": "#/definitions/errorx.CodeErrorResponse" } } } } }, "/casbin/test": { "get": { "description": "casbin 鉴权测试", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "CasBin" ], "summary": "casbin 鉴权测试", "parameters": [ { "type": "string", "description": "身份", "name": "identity", "in": "query", "required": true }, { "type": "string", "description": "系统", "name": "system", "in": "query", "required": true }, { "type": "string", "description": "api", "name": "api", "in": "query", "required": true }, { "type": "string", "description": "动作", "name": "act", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "data": { "type": "string" } } } ] } }, "default": { "description": "", "schema": { "$ref": "#/definitions/errorx.CodeErrorResponse" } } } } }, "/error": { "get": { "description": "错误信息示例", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Error" ], "summary": "错误处理", "responses": { "default": { "description": "", "schema": { "$ref": "#/definitions/errorx.CodeErrorResponse" } } } }, "put": { "description": "错误信息示例", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Error" ], "summary": "错误处理", "responses": { "default": { "description": "", "schema": { "$ref": "#/definitions/errorx.CodeErrorResponse" } } } }, "post": { "description": "错误信息示例", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Error" ], "summary": "错误处理", "responses": { "default": { "description": "", "schema": { "$ref": "#/definitions/errorx.CodeErrorResponse" } } } }, "delete": { "description": "错误信息示例", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Error" ], "summary": "错误处理", "responses": { "default": { "description": "", "schema": { "$ref": "#/definitions/errorx.CodeErrorResponse" } } } }, "patch": { "description": "错误信息示例", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Error" ], "summary": "错误处理", "responses": { "default": { "description": "", "schema": { "$ref": "#/definitions/errorx.CodeErrorResponse" } } } } }, "/routes": { "get": { "description": "获取所有路由信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Routes" ], "summary": "获取所有路由", "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/definitions/fiber.Route" } } } } } ] } } } } }, "/user/account": { "get": { "security": [ { "Token": [] } ], "description": "根据 账号 获取用户信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "User" ], "summary": "根据 账号 获取用户信息", "parameters": [ { "type": "string", "description": "账号名称", "name": "account", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/models.User" } } } ] } }, "default": { "description": "", "schema": { "$ref": "#/definitions/errorx.CodeErrorResponse" } } } } } }, "definitions": { "errorx.CodeErrorResponse": { "type": "object", "properties": { "code": { "type": "integer", "example": 200 }, "data": {}, "msg": { "type": "string", "example": "OK" } } }, "fiber.Route": { "type": "object", "properties": { "method": { "description": "Public fields", "type": "string" }, "name": { "description": "Route's name", "type": "string" }, "params": { "description": "Case sensitive param keys", "type": "array", "items": { "type": "string" } }, "path": { "description": "Original registered route path", "type": "string" } } }, "models.User": { "type": "object", "properties": { "account": { "type": "string" }, "active": { "type": "boolean" }, "alias": { "type": "string" }, "contact": { "type": "string" }, "email": { "type": "string" }, "emailVerify": { "type": "boolean" }, "id": { "type": "string" }, "lastLoginTime": { "type": "string" }, "memo": { "type": "string" }, "registerTime": { "type": "string" }, "userName": { "type": "string" } } }, "response.Response": { "type": "object", "properties": { "code": { "type": "integer", "example": 200 }, "data": {}, "msg": { "type": "string", "example": "OK" } } } }, "securityDefinitions": { "Token": { "type": "apiKey", "name": "token", "in": "header" } } }` // SwaggerInfo holds exported Swagger Info so clients can modify it var SwaggerInfo = &swag.Spec{ Version: "1.0", Host: "", BasePath: "/", Schemes: []string{}, Title: "GoFiber Study API", Description: "基于 Fiber 框架的 swagger", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, } func init() { swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) }