gofiber-study/docs/swagger.yaml

53 lines
1.2 KiB
YAML
Raw Normal View History

2022-10-03 15:10:03 +08:00
basePath: /
definitions:
errorx.CodeErrorResponse:
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:
type: string
"400":
description: Bad Request
schema:
$ref: '#/definitions/errorx.CodeErrorResponse'
"404":
description: Not Found
schema:
$ref: '#/definitions/errorx.CodeErrorResponse'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/errorx.CodeErrorResponse'
summary: HelloWorld
tags:
- HelloWorld
swagger: "2.0"