mirror of
https://gitee.com/shikong-sk/gofiber-study
synced 2025-02-24 07:42:15 +08:00
146 lines
3.1 KiB
YAML
146 lines
3.1 KiB
YAML
basePath: /
|
|
definitions:
|
|
errorx.CodeErrorResponse:
|
|
properties:
|
|
code:
|
|
example: 200
|
|
type: integer
|
|
data: {}
|
|
msg:
|
|
example: OK
|
|
type: string
|
|
type: object
|
|
response.Response:
|
|
properties:
|
|
code:
|
|
example: 200
|
|
type: integer
|
|
data: {}
|
|
msg:
|
|
example: OK
|
|
type: string
|
|
type: object
|
|
info:
|
|
contact:
|
|
email: 919411476@qq.com
|
|
name: Shikong
|
|
description: 基于 Fiber 框架的 swagger
|
|
license:
|
|
name: Apache 2.0
|
|
url: http://www.apache.org/licenses/LICENSE-2.0.html
|
|
termsOfService: http://swagger.io/terms/
|
|
title: GoFiber Study API
|
|
version: "1.0"
|
|
paths:
|
|
/:
|
|
get:
|
|
consumes:
|
|
- application/json
|
|
description: 简单的 HelloWorld 示例
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
allOf:
|
|
- $ref: '#/definitions/response.Response'
|
|
- properties:
|
|
data:
|
|
type: string
|
|
type: object
|
|
default:
|
|
description: ""
|
|
schema:
|
|
$ref: '#/definitions/errorx.CodeErrorResponse'
|
|
summary: HelloWorld
|
|
tags:
|
|
- HelloWorld
|
|
/error:
|
|
delete:
|
|
consumes:
|
|
- application/json
|
|
description: 错误信息示例
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
default:
|
|
description: ""
|
|
schema:
|
|
$ref: '#/definitions/errorx.CodeErrorResponse'
|
|
summary: 错误处理
|
|
tags:
|
|
- Error
|
|
get:
|
|
consumes:
|
|
- application/json
|
|
description: 错误信息示例
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
default:
|
|
description: ""
|
|
schema:
|
|
$ref: '#/definitions/errorx.CodeErrorResponse'
|
|
summary: 错误处理
|
|
tags:
|
|
- Error
|
|
patch:
|
|
consumes:
|
|
- application/json
|
|
description: 错误信息示例
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
default:
|
|
description: ""
|
|
schema:
|
|
$ref: '#/definitions/errorx.CodeErrorResponse'
|
|
summary: 错误处理
|
|
tags:
|
|
- Error
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: 错误信息示例
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
default:
|
|
description: ""
|
|
schema:
|
|
$ref: '#/definitions/errorx.CodeErrorResponse'
|
|
summary: 错误处理
|
|
tags:
|
|
- Error
|
|
put:
|
|
consumes:
|
|
- application/json
|
|
description: 错误信息示例
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
default:
|
|
description: ""
|
|
schema:
|
|
$ref: '#/definitions/errorx.CodeErrorResponse'
|
|
summary: 错误处理
|
|
tags:
|
|
- Error
|
|
/routes:
|
|
get:
|
|
consumes:
|
|
- application/json
|
|
description: 获取所有路由信息
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
summary: 获取所有路由
|
|
tags:
|
|
- Routes
|
|
swagger: "2.0"
|