IM/open-im-server
1
0
Fork 0
mirror of https://github.com/openimsdk/open-im-server.git synced 2026-05-04 17:15:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

add swagger demo

Browse Source
This commit is contained in:
wangchuxiao
2022-06-24 17:45:33 +08:00
parent db7ef3ac4b
commit 99062805ec
16 changed files with 367 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/open_im_api/docs/docs.go
+85
View File
@@ -0,0 +1,85 @@
// 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": "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": {
"/hello": {
"get": {
"description": "向你说Hello",
"consumes": [
"application/json"
],
"tags": [
"测试"
],
"summary": "测试SayHello",
"parameters": [
{
"type": "string",
"description": "人名",
"name": "who",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "{\"msg\": \"hello Razeen\"}",
"schema": {
"type": "string"
}
},
"400": {
"description": "{\"msg\": \"who are you\"}",
"schema": {
"type": "string"
}
}
}
}
}
},
"securityDefinitions": {
"BasicAuth": {
"type": "basic"
}
}
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "1.0",
Host: "localhost:8080",
BasePath: "/api/v1",
Schemes: []string{},
Title: "Swagger Example API",
Description: "This is a sample server celler server.",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
}
func init() {
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
}
cmd/open_im_api/docs/swagger.json
+62
View File
@@ -0,0 +1,62 @@
{
"swagger": "2.0",
"info": {
"description": "This is a sample server celler server.",
"title": "Swagger Example 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/v1",
"paths": {
"/hello": {
"get": {
"description": "向你说Hello",
"consumes": [
"application/json"
],
"tags": [
"测试"
],
"summary": "测试SayHello",
"parameters": [
{
"type": "string",
"description": "人名",
"name": "who",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "{\"msg\": \"hello Razeen\"}",
"schema": {
"type": "string"
}
},
"400": {
"description": "{\"msg\": \"who are you\"}",
"schema": {
"type": "string"
}
}
}
}
}
},
"securityDefinitions": {
"BasicAuth": {
"type": "basic"
}
}
}
cmd/open_im_api/docs/swagger.yaml
+42
View File
@@ -0,0 +1,42 @@
basePath: /api/v1
host: localhost:8080
info:
contact:
email: support@swagger.io
name: API Support
url: http://www.swagger.io/support
description: This is a sample server celler server.
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
termsOfService: http://swagger.io/terms/
title: Swagger Example API
version: "1.0"
paths:
/hello:
get:
consumes:
- application/json
description: 向你说Hello
parameters:
- description: 人名
in: query
name: who
required: true
type: string
responses:
"200":
description: '{"msg": "hello Razeen"}'
schema:
type: string
"400":
description: '{"msg": "who are you"}'
schema:
type: string
summary: 测试SayHello
tags:
- 测试
securityDefinitions:
BasicAuth:
type: basic
swagger: "2.0"