remove: md

This commit is contained in:
ctwj
2025-07-17 02:18:21 +08:00
parent c6147d6c2c
commit b2644accdf
34 changed files with 0 additions and 5714 deletions

View File

@@ -1,379 +0,0 @@
// Package docs Code generated by swaggo/swag. DO NOT EDIT
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": "API Support",
"url": "http://www.swagger.io/support",
"email": "support@swagger.io"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/api/public/hot-dramas": {
"get": {
"description": "获取热门剧列表,支持分页",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"PublicAPI"
],
"summary": "获取热门剧列表",
"parameters": [
{
"type": "string",
"description": "API访问令牌",
"name": "X-API-Token",
"in": "header",
"required": true
},
{
"type": "integer",
"default": 1,
"description": "页码",
"name": "page",
"in": "query"
},
{
"maximum": 100,
"type": "integer",
"default": 20,
"description": "每页数量",
"name": "page_size",
"in": "query"
}
],
"responses": {
"200": {
"description": "获取成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "认证失败",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/public/resources/add": {
"post": {
"description": "通过公开API添加单个资源到待处理列表",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"PublicAPI"
],
"summary": "单个添加资源",
"parameters": [
{
"type": "string",
"description": "API访问令牌",
"name": "X-API-Token",
"in": "header",
"required": true
},
{
"description": "资源信息",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dto.ReadyResourceRequest"
}
}
],
"responses": {
"200": {
"description": "添加成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "认证失败",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/public/resources/batch-add": {
"post": {
"description": "通过公开API批量添加多个资源到待处理列表",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"PublicAPI"
],
"summary": "批量添加资源",
"parameters": [
{
"type": "string",
"description": "API访问令牌",
"name": "X-API-Token",
"in": "header",
"required": true
},
{
"description": "批量资源信息",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dto.BatchReadyResourceRequest"
}
}
],
"responses": {
"200": {
"description": "批量添加成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "认证失败",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/public/resources/search": {
"get": {
"description": "搜索资源,支持关键词、标签、分类过滤",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"PublicAPI"
],
"summary": "资源搜索",
"parameters": [
{
"type": "string",
"description": "API访问令牌",
"name": "X-API-Token",
"in": "header",
"required": true
},
{
"type": "string",
"description": "搜索关键词",
"name": "keyword",
"in": "query"
},
{
"type": "string",
"description": "标签过滤",
"name": "tag",
"in": "query"
},
{
"type": "string",
"description": "分类过滤",
"name": "category",
"in": "query"
},
{
"type": "integer",
"default": 1,
"description": "页码",
"name": "page",
"in": "query"
},
{
"maximum": 100,
"type": "integer",
"default": 20,
"description": "每页数量",
"name": "page_size",
"in": "query"
}
],
"responses": {
"200": {
"description": "搜索成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "认证失败",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
}
},
"definitions": {
"dto.BatchReadyResourceRequest": {
"type": "object",
"required": [
"resources"
],
"properties": {
"resources": {
"type": "array",
"items": {
"$ref": "#/definitions/dto.ReadyResourceRequest"
}
}
}
},
"dto.ReadyResourceRequest": {
"type": "object",
"required": [
"title",
"url"
],
"properties": {
"category": {
"type": "string",
"example": "示例分类"
},
"description": {
"type": "string",
"example": "这是一个示例资源描述"
},
"extra": {
"type": "string",
"example": "额外信息"
},
"img": {
"type": "string",
"example": "https://example.com/image.jpg"
},
"source": {
"type": "string",
"example": "数据来源"
},
"tags": {
"type": "string",
"example": "标签1,标签2"
},
"title": {
"type": "string",
"example": "示例资源标题"
},
"url": {
"type": "string",
"example": "https://example.com/resource"
}
}
}
},
"securityDefinitions": {
"ApiTokenAuth": {
"description": "API Token认证",
"type": "apiKey",
"name": "X-API-Token",
"in": "header"
}
}
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "1.0",
Host: "localhost:8080",
BasePath: "/api/public",
Schemes: []string{},
Title: "网盘资源管理系统公开API",
Description: "网盘资源管理系统的公开API接口文档",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
LeftDelim: "{{",
RightDelim: "}}",
}
func init() {
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
}

View File

@@ -1,355 +0,0 @@
{
"swagger": "2.0",
"info": {
"description": "网盘资源管理系统的公开API接口文档",
"title": "网盘资源管理系统公开API",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"name": "API Support",
"url": "http://www.swagger.io/support",
"email": "support@swagger.io"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "1.0"
},
"host": "localhost:8080",
"basePath": "/api/public",
"paths": {
"/api/public/hot-dramas": {
"get": {
"description": "获取热门剧列表,支持分页",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"PublicAPI"
],
"summary": "获取热门剧列表",
"parameters": [
{
"type": "string",
"description": "API访问令牌",
"name": "X-API-Token",
"in": "header",
"required": true
},
{
"type": "integer",
"default": 1,
"description": "页码",
"name": "page",
"in": "query"
},
{
"maximum": 100,
"type": "integer",
"default": 20,
"description": "每页数量",
"name": "page_size",
"in": "query"
}
],
"responses": {
"200": {
"description": "获取成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "认证失败",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/public/resources/add": {
"post": {
"description": "通过公开API添加单个资源到待处理列表",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"PublicAPI"
],
"summary": "单个添加资源",
"parameters": [
{
"type": "string",
"description": "API访问令牌",
"name": "X-API-Token",
"in": "header",
"required": true
},
{
"description": "资源信息",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dto.ReadyResourceRequest"
}
}
],
"responses": {
"200": {
"description": "添加成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "认证失败",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/public/resources/batch-add": {
"post": {
"description": "通过公开API批量添加多个资源到待处理列表",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"PublicAPI"
],
"summary": "批量添加资源",
"parameters": [
{
"type": "string",
"description": "API访问令牌",
"name": "X-API-Token",
"in": "header",
"required": true
},
{
"description": "批量资源信息",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/dto.BatchReadyResourceRequest"
}
}
],
"responses": {
"200": {
"description": "批量添加成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "认证失败",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/public/resources/search": {
"get": {
"description": "搜索资源,支持关键词、标签、分类过滤",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"PublicAPI"
],
"summary": "资源搜索",
"parameters": [
{
"type": "string",
"description": "API访问令牌",
"name": "X-API-Token",
"in": "header",
"required": true
},
{
"type": "string",
"description": "搜索关键词",
"name": "keyword",
"in": "query"
},
{
"type": "string",
"description": "标签过滤",
"name": "tag",
"in": "query"
},
{
"type": "string",
"description": "分类过滤",
"name": "category",
"in": "query"
},
{
"type": "integer",
"default": 1,
"description": "页码",
"name": "page",
"in": "query"
},
{
"maximum": 100,
"type": "integer",
"default": 20,
"description": "每页数量",
"name": "page_size",
"in": "query"
}
],
"responses": {
"200": {
"description": "搜索成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "认证失败",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
}
},
"definitions": {
"dto.BatchReadyResourceRequest": {
"type": "object",
"required": [
"resources"
],
"properties": {
"resources": {
"type": "array",
"items": {
"$ref": "#/definitions/dto.ReadyResourceRequest"
}
}
}
},
"dto.ReadyResourceRequest": {
"type": "object",
"required": [
"title",
"url"
],
"properties": {
"category": {
"type": "string",
"example": "示例分类"
},
"description": {
"type": "string",
"example": "这是一个示例资源描述"
},
"extra": {
"type": "string",
"example": "额外信息"
},
"img": {
"type": "string",
"example": "https://example.com/image.jpg"
},
"source": {
"type": "string",
"example": "数据来源"
},
"tags": {
"type": "string",
"example": "标签1,标签2"
},
"title": {
"type": "string",
"example": "示例资源标题"
},
"url": {
"type": "string",
"example": "https://example.com/resource"
}
}
}
},
"securityDefinitions": {
"ApiTokenAuth": {
"description": "API Token认证",
"type": "apiKey",
"name": "X-API-Token",
"in": "header"
}
}
}

View File

@@ -1,246 +0,0 @@
basePath: /api/public
definitions:
dto.BatchReadyResourceRequest:
properties:
resources:
items:
$ref: '#/definitions/dto.ReadyResourceRequest'
type: array
required:
- resources
type: object
dto.ReadyResourceRequest:
properties:
category:
example: 示例分类
type: string
description:
example: 这是一个示例资源描述
type: string
extra:
example: 额外信息
type: string
img:
example: https://example.com/image.jpg
type: string
source:
example: 数据来源
type: string
tags:
example: 标签1,标签2
type: string
title:
example: 示例资源标题
type: string
url:
example: https://example.com/resource
type: string
required:
- title
- url
type: object
host: localhost:8080
info:
contact:
email: support@swagger.io
name: API Support
url: http://www.swagger.io/support
description: 网盘资源管理系统的公开API接口文档
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
termsOfService: http://swagger.io/terms/
title: 网盘资源管理系统公开API
version: "1.0"
paths:
/api/public/hot-dramas:
get:
consumes:
- application/json
description: 获取热门剧列表,支持分页
parameters:
- description: API访问令牌
in: header
name: X-API-Token
required: true
type: string
- default: 1
description: 页码
in: query
name: page
type: integer
- default: 20
description: 每页数量
in: query
maximum: 100
name: page_size
type: integer
produces:
- application/json
responses:
"200":
description: 获取成功
schema:
additionalProperties: true
type: object
"401":
description: 认证失败
schema:
additionalProperties: true
type: object
"500":
description: 服务器内部错误
schema:
additionalProperties: true
type: object
summary: 获取热门剧列表
tags:
- PublicAPI
/api/public/resources/add:
post:
consumes:
- application/json
description: 通过公开API添加单个资源到待处理列表
parameters:
- description: API访问令牌
in: header
name: X-API-Token
required: true
type: string
- description: 资源信息
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.ReadyResourceRequest'
produces:
- application/json
responses:
"200":
description: 添加成功
schema:
additionalProperties: true
type: object
"400":
description: 请求参数错误
schema:
additionalProperties: true
type: object
"401":
description: 认证失败
schema:
additionalProperties: true
type: object
"500":
description: 服务器内部错误
schema:
additionalProperties: true
type: object
summary: 单个添加资源
tags:
- PublicAPI
/api/public/resources/batch-add:
post:
consumes:
- application/json
description: 通过公开API批量添加多个资源到待处理列表
parameters:
- description: API访问令牌
in: header
name: X-API-Token
required: true
type: string
- description: 批量资源信息
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.BatchReadyResourceRequest'
produces:
- application/json
responses:
"200":
description: 批量添加成功
schema:
additionalProperties: true
type: object
"400":
description: 请求参数错误
schema:
additionalProperties: true
type: object
"401":
description: 认证失败
schema:
additionalProperties: true
type: object
"500":
description: 服务器内部错误
schema:
additionalProperties: true
type: object
summary: 批量添加资源
tags:
- PublicAPI
/api/public/resources/search:
get:
consumes:
- application/json
description: 搜索资源,支持关键词、标签、分类过滤
parameters:
- description: API访问令牌
in: header
name: X-API-Token
required: true
type: string
- description: 搜索关键词
in: query
name: keyword
type: string
- description: 标签过滤
in: query
name: tag
type: string
- description: 分类过滤
in: query
name: category
type: string
- default: 1
description: 页码
in: query
name: page
type: integer
- default: 20
description: 每页数量
in: query
maximum: 100
name: page_size
type: integer
produces:
- application/json
responses:
"200":
description: 搜索成功
schema:
additionalProperties: true
type: object
"401":
description: 认证失败
schema:
additionalProperties: true
type: object
"500":
description: 服务器内部错误
schema:
additionalProperties: true
type: object
summary: 资源搜索
tags:
- PublicAPI
securityDefinitions:
ApiTokenAuth:
description: API Token认证
in: header
name: X-API-Token
type: apiKey
swagger: "2.0"