调整swagger注解位置

This commit is contained in:
2025-09-12 20:32:29 +08:00
parent 0884e229fe
commit 52669e7055
5 changed files with 18 additions and 50 deletions

View File

@@ -9,15 +9,7 @@ const docTemplate = `{
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"contact": {
"name": "Divano",
"url": "http://www.example.com",
"email": "divano@example.com"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"contact": {},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
@@ -423,12 +415,12 @@ const docTemplate = `{
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "1.0",
Host: "localhost:8086",
BasePath: "/api/v1",
Version: "",
Host: "",
BasePath: "",
Schemes: []string{},
Title: "猪场管理系统 API",
Description: "这是一个用于管理猪场设备的后端服务。",
Title: "",
Description: "",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
LeftDelim: "{{",

View File

@@ -1,21 +1,8 @@
{
"swagger": "2.0",
"info": {
"description": "这是一个用于管理猪场设备的后端服务。",
"title": "猪场管理系统 API",
"contact": {
"name": "Divano",
"url": "http://www.example.com",
"email": "divano@example.com"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "1.0"
"contact": {}
},
"host": "localhost:8086",
"basePath": "/api/v1",
"paths": {
"/devices": {
"get": {

View File

@@ -1,4 +1,3 @@
basePath: /api/v1
definitions:
controller.Properties:
type: object
@@ -126,18 +125,8 @@ definitions:
example: testuser
type: string
type: object
host: localhost:8086
info:
contact:
email: divano@example.com
name: Divano
url: http://www.example.com
description: 这是一个用于管理猪场设备的后端服务。
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
title: 猪场管理系统 API
version: "1.0"
contact: {}
paths:
/devices:
get:

View File

@@ -1,5 +1,15 @@
package api
// @title 猪场管理系统 API
// @version 1.0
// @description 这是一个用于管理猪场设备的后端服务。
// @contact.name Divano
// @contact.url http://www.example.com
// @contact.email divano@example.com
// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html
// @host localhost:8086
// @BasePath /api/v1
import (
"context"
"fmt"

10
main.go
View File

@@ -7,16 +7,6 @@ import (
"git.huangwc.com/pig/pig-farm-controller/internal/core"
)
// @title 猪场管理系统 API
// @version 1.0
// @description 这是一个用于管理猪场设备的后端服务。
// @contact.name Divano
// @contact.url http://www.example.com
// @contact.email divano@example.com
// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html
// @host localhost:8086
// @BasePath /api/v1
func main() {
// 1. 创建应用实例
// 所有复杂的初始化逻辑都已封装在 NewApplication 中