captain-neo/openapi3-framworks-compare
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

add swag && proto examples

Browse Source
This commit is contained in:
CaptainNEO
2022-03-08 22:09:04 +08:00
parent 2c8ba685a3
commit b8656937f6
12 changed files with 1638 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

203
go/swag_example/docs/docs.go Normal file
View File

@@ -0,0 +1,203 @@
// Package docs GENERATED BY THE COMMAND ABOVE; 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": "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": {
"/v2/object": {
"get": {
"description": "blabla...",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "get an object",
"parameters": [
{
"type": "integer",
"description": "Some ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"$ref": "#/definitions/main.Object"
}
},
"400": {
"description": "We need ID!!",
"schema": {
"$ref": "#/definitions/main.APIError"
}
},
"404": {
"description": "Can not find ID",
"schema": {
"$ref": "#/definitions/main.APIError"
}
}
}
},
"post": {
"description": "blabla...",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"summary": "create an object.",
"parameters": [
{
"description": "Add Object",
"name": "object",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/main.Object"
}
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"$ref": "#/definitions/main.Object"
}
},
"400": {
"description": "We need ID!!",
"schema": {
"$ref": "#/definitions/main.APIError"
}
},
"404": {
"description": "Can not find ID",
"schema": {
"$ref": "#/definitions/main.APIError"
}
}
}
}
},
"/v2/object/{id}": {
"get": {
"description": "get struct array by ID",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"type": "integer",
"description": "Offset",
"name": "offset",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "Offset",
"name": "limit",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"type": "string"
}
},
"400": {
"description": "We need ID!!",
"schema": {
"$ref": "#/definitions/main.APIError"
}
},
"404": {
"description": "Can not find ID",
"schema": {
"$ref": "#/definitions/main.APIError"
}
}
}
}
}
},
"definitions": {
"main.APIError": {
"type": "object",
"properties": {
"createdAt": {
"type": "string"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
},
"main.Object": {
"type": "object",
"properties": {
"id": {
"description": "这是一个ID",
"type": "integer"
},
"name": {
"description": "这是对象的名字",
"type": "string"
}
}
}
}
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "1.0",
Host: "petstore.swagger.io:8080",
BasePath: "/v2",
Schemes: []string{},
Title: "Swagger Example API",
Description: "This is a sample server Petstore server.",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
}
func init() {
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
}