Gin-Vue-Admin

https://www.gin-vue-admin.com/guide/
Admin
Gin-Vue-Admin is a full-stack administrative framework built with Gin (Go) for the backend and...
Tokens:4,669
Snippets:43
Trust Score:8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Backend Model Template Example

Source: https://www.gin-vue-admin.com/guide/server/code-generator.html

A snippet from the model.go.tpl file demonstrating conditional imports and struct definition using Go template syntax.

```go
// 自动生成模板{{.StructName}}
package {{.Package}}

{{- if not .OnlyTemplate}}
import (
	{{- if .GvaModel }}
	"{{.Module}}/global"
	{{- end }}
	{{- if or .HasTimer }}
	"time"
	{{- end }}
	{{- if .NeedJSON }}
	"gorm.io/datatypes"
	{{- end }}
)
{{- end }}

// {{.Description}} 结构体  {{.StructName}}
type {{.StructName}} struct {
{{- if not .OnlyTemplate}}
{{- if .GvaModel }}
    global.GVA_MODEL
{{- end }}
```

--------------------------------

### Huawei OBS YAML Configuration

Source: https://www.gin-vue-admin.com/guide/server/config/oss.html

Example configuration block for Huawei OBS settings.

```yaml
hua-wei-obs:
  path: you-path
  bucket: you-bucket
  endpoint: you-endpoint
  access-key: you-access-key
  secret-key: you-secret-key
```

--------------------------------

### Frontend Table View Template Example

Source: https://www.gin-vue-admin.com/guide/server/code-generator.html

A snippet from the table.vue.tpl file showing how to iterate over fields to generate search form items and table columns.

```vue
{{- $global := . }}
{{- $templateID := printf "%s_%s" .Package .StructName }}
{{- if .IsAdd }}

// 请在搜索条件中增加如下代码
{{- range .Fields}}
    {{- if .FieldSearchType}}
{{ GenerateSearchFormItem .}}
    {{ end }}
{{ end }}


// 表格增加如下列代码

{{- range .Fields}}
    {{- if .Table}}
       {{ GenerateTableColumn . }}
    {{- end }}
{{- end }}
```

--------------------------------

### CLI 命令查看与调用

Source: https://www.gin-vue-admin.com/guide/server/ai-cli.html

查看帮助信息及执行具体业务接口命令的示例。

```bash
opsctl --help          # 列出全部命令
opsctl <命令> --help    # 查看某个命令需要哪些参数
```

```bash
opsctl user-list --page 1 --pageSize 10
```

--------------------------------

### Configure Aliyun OSS

Source: https://www.gin-vue-admin.com/guide/server/config/oss.html

Settings for connecting to Aliyun Object Storage Service.

```yaml
aliyun-oss:
  endpoint: yourEndpoint
  access-key-id: yourAccessKeyId
  access-key-secret: yourAccessKeySecret
  bucket-name: yourBucketName
  bucket-url: yourBucketUrl
  base-path: yourBasePath
```

--------------------------------

### Configure MinIO OSS

Source: https://www.gin-vue-admin.com/guide/server/config/oss.html

Settings for connecting to a MinIO storage instance.

```yaml
minio:
  endpoint: yourEndpoint
  access-key-id: yourAccessKeyId
  access-key-secret: yourAccessKeySecret
  bucket-name: yourBucketName
  use-ssl: false
  base-path: ""
  bucket-url: "http://host:9000/yourBucketName"
```

--------------------------------

### CLI 目录结构

Source: https://www.gin-vue-admin.com/guide/server/ai-cli.html

解压后的 Skill 目录结构，包含用于 Claude Code 识别的 SKILL.md 和命令清单。

```text
opsctl-cli/
├─ SKILL.md            # 含 name / description，Claude Code 据此识别为一个 skill
├─ opsctl(.exe)        # 编译好的 CLI，与 SKILL.md 同级
└─ references/
   ├─ README.md        # 命令使用说明
   └─ manifest.json    # 命令清单
```

--------------------------------

### CLI 登录与配置

Source: https://www.gin-vue-admin.com/guide/server/ai-cli.html

使用 JWT 进行登录鉴权，以及更新本地服务地址的命令示例。

```bash
opsctl login --token <你的JWT>
```

```bash
gva --manifest opsctl.manifest.json login --token <JWT>
```

```bash
opsctl set-base-url http://127.0.0.1:8888
```

--------------------------------

### Configure AWS S3

Source: https://www.gin-vue-admin.com/guide/server/config/oss.html

Settings for connecting to AWS S3 or compatible storage services.

```yaml
aws-s3:
  bucket: xxxxx-10005608
  region: ap-shanghai
  endpoint: ""
  s3-force-path-style: false
  disable-ssl: false
  secret-id: your-secret-id
  secret-key: your-secret-key
  base-url: https://gin.vue.admin
  path-prefix: github.com/flipped-aurora/gin-vue-admin/server
```

--------------------------------

### Configure Cloudflare R2

Source: https://www.gin-vue-admin.com/guide/server/config/oss.html

Settings for connecting to Cloudflare R2 storage.

```yaml
cloudflare-r2:
  bucket: xxxx0bucket
  base-url: https://gin.vue.admin.com
  path: uploads
  account-id: xxx_account_id
  access-key-id: xxx_key_id
  secret-access-key: xxx_secret_key
```

--------------------------------

### Logging with Context

Source: https://www.gin-vue-admin.com/guide/server/core/zap.html

Usage of the logger within business logic to automatically extract and output trace information from the context.

```go
logger.WithCtx(ctx).Mod("biz").Field("user_id", 1).Info("查询用户成功")
logger.WithCtx(ctx).Mod("biz").Err(err).Error("查询用户失败")
logger.Bg().Mod("system").Info("register swagger handler") // 无 ctx 时用 Bg()
```

--------------------------------

### Cloud Storage Go Struct Definitions

Source: https://www.gin-vue-admin.com/guide/server/config/oss.html

Go struct definitions for various cloud storage providers used in the application.

```go
type AliyunOSS struct {
	Endpoint        string `mapstructure:"endpoint" json:"endpoint" yaml:"endpoint"`
	AccessKeyId     string `mapstructure:"access-key-id" json:"access-key-id" yaml:"access-key-id"`
	AccessKeySecret string `mapstructure:"access-key-secret" json:"access-key-secret" yaml:"access-key-secret"`
	BucketName      string `mapstructure:"bucket-name" json:"bucket-name" yaml:"bucket-name"`
	BucketUrl       string `mapstructure:"bucket-url" json:"bucket-url" yaml:"bucket-url"`
	BasePath        string `mapstructure:"base-path" json:"base-path" yaml:"base-path"`
}

type TencentCOS struct {
	Bucket     string `mapstructure:"bucket" json:"bucket" yaml:"bucket"`
	Region     string `mapstructure:"region" json:"region" yaml:"region"`
	SecretID   string `mapstructure:"secret-id" json:"secret-id" yaml:"secret-id"`
	SecretKey  string `mapstructure:"secret-key" json:"secret-key" yaml:"secret-key"`
	BaseURL    string `mapstructure:"base-url" json:"base-url" yaml:"base-url"`
	PathPrefix string `mapstructure:"path-prefix" json:"path-prefix" yaml:"path-prefix"`
}

type AwsS3 struct {
	Bucket           string `mapstructure:"bucket" json:"bucket" yaml:"bucket"`
	Region           string `mapstructure:"region" json:"region" yaml:"region"`
	Endpoint         string `mapstructure:"endpoint" json:"endpoint" yaml:"endpoint"`
	SecretID         string `mapstructure:"secret-id" json:"secret-id" yaml:"secret-id"`
	SecretKey        string `mapstructure:"secret-key" json:"secret-key" yaml:"secret-key"`
	BaseURL          string `mapstructure:"base-url" json:"base-url" yaml:"base-url"`
	PathPrefix       string `mapstructure:"path-prefix" json:"path-prefix" yaml:"path-prefix"`
	S3ForcePathStyle bool   `mapstructure:"s3-force-path-style" json:"s3-force-path-style" yaml:"s3-force-path-style"`
	DisableSSL       bool   `mapstructure:"disable-ssl" json:"disable-ssl" yaml:"disable-ssl"`
}

type CloudflareR2 struct {
	Bucket          string `mapstructure:"bucket" json:"bucket" yaml:"bucket"`
	BaseURL         string `mapstructure:"base-url" json:"base-url" yaml:"base-url"`
	Path            string `mapstructure:"path" json:"path" yaml:"path"`
	AccountID       string `mapstructure:"account-id" json:"account-id" yaml:"account-id"`
	AccessKeyID     string `mapstructure:"access-key-id" json:"access-key-id" yaml:"access-key-id"`
	SecretAccessKey string `mapstructure:"secret-access-key" json:"secret-access-key" yaml:"secret-access-key"`
}

type HuaWeiObs struct {
	Path      string `mapstructure:"path" json:"path" yaml:"path"`
	Bucket    string `mapstructure:"bucket" json:"bucket" yaml:"bucket"`
	Endpoint  string `mapstructure:"endpoint" json:"endpoint" yaml:"endpoint"`
	AccessKey string `mapstructure:"access-key" json:"access-key" yaml:"access-key"`
	SecretKey string `mapstructure:"secret-key" json:"secret-key" yaml:"secret-key"`
}

type Minio struct {
	Endpoint        string `mapstructure:"endpoint" json:"endpoint" yaml:"endpoint"`
	AccessKeyId     string `mapstructure:"access-key-id" json:"access-key-id" yaml:"access-key-id"`
	AccessKeySecret string `mapstructure:"access-key-secret" json:"access-key-secret" yaml:"access-key-secret"`
	BucketName      string `mapstructure:"bucket-name" json:"bucket-name" yaml:"bucket-name"`
	UseSSL          bool   `mapstructure:"use-ssl" json:"use-ssl" yaml:"use-ssl"`
	BasePath        string `mapstructure:"base-path" json:"base-path" yaml:"base-path"`
	BucketUrl       string `mapstructure:"bucket-url" json:"bucket-url" yaml:"bucket-url"`
}
```

--------------------------------

### Configure Tencent COS

Source: https://www.gin-vue-admin.com/guide/server/config/oss.html

Settings for connecting to Tencent Cloud Object Storage.

```yaml
tencent-cos:
  bucket: xxxxx-10005608
  region: ap-shanghai
  secret-id: your-secret-id
  secret-key: your-secret-key
  base-url: https://gin.vue.admin
  path-prefix: github.com/flipped-aurora/gin-vue-admin/server
```

--------------------------------

### CORS Go 结构体定义

Source: https://www.gin-vue-admin.com/guide/server/config/cors.html

用于映射 CORS 配置的 Go 数据结构。

```go
type CORS struct {
	Mode      string          `mapstructure:"mode" json:"mode" yaml:"mode"`
	Whitelist []CORSWhitelist `mapstructure:"whitelist" json:"whitelist" yaml:"whitelist"`
}

type CORSWhitelist struct {
	AllowOrigin      string `mapstructure:"allow-origin" json:"allow-origin" yaml:"allow-origin"`
	AllowMethods     string `mapstructure:"allow-methods" json:"allow-methods" yaml:"allow-methods"`
	AllowHeaders     string `mapstructure:"allow-headers" json:"allow-headers" yaml:"allow-headers"`
	ExposeHeaders    string `mapstructure:"expose-headers" json:"expose-headers" yaml:"expose-headers"`
	AllowCredentials bool   `mapstructure:"allow-credentials" json:"allow-credentials" yaml:"allow-credentials"`
}
```

--------------------------------

### Zap Logger Configuration

Source: https://www.gin-vue-admin.com/guide/server/core/zap.html

The YAML configuration structure for the Zap logger, defining log levels, output formats, and access logging behavior.

```yaml
zap:
  level: 'info'
  format: 'console'
  prefix: '[GIN-VUE-ADMIN]'
  director: 'log'
  show-line: true
  encode-level: 'LowercaseColorLevelEncoder'
  stacktrace-key: 'stacktrace'
  log-in-console: true
  retention-day: 7
  access-req-body: true
  access-resp-data: true
  access-req-headers: true
  access-log-max-bytes: 1024
  file-only-modules:
    - http
    - sql
```

--------------------------------

### CORS YAML 配置示例

Source: https://www.gin-vue-admin.com/guide/server/config/cors.html

定义跨域模式及白名单规则的 YAML 配置文件。

```yaml
# 跨域配置
cors:
  mode: strict-whitelist # 放行模式: allow-all, 放行全部; whitelist, 白名单模式, 来自白名单内域名的请求添加 cors 头; strict-whitelist 严格白名单模式, 白名单外的请求一律拒绝
  whitelist:
    - allow-origin: example1.com
      allow-headers: Content-Type,AccessToken,X-CSRF-Token, Authorization, Token,X-Token,X-User-Id
      allow-methods: POST, GET
      expose-headers: Content-Length, Access-Control-Allow-Origin, Access-Control-Allow-Headers, Content-Type
      allow-credentials: true # 布尔值
```
Tokens:
Raw