skilld
All skills
gogf avatar

/goframe-v2

@911705d
by GoFramegogf/skills81 stars
3

GoFrame v2 development skill. Use only when the target Go project uses or is explicitly adopting GoFrame v2: the nearest go.mod requires github.com/gogf/gf/v2, existing Go files import github.com/gogf/gf/v2 or any github.com/gogf/gf/v2/... component package, or the user asks to scaffold, migrate, or build with GoFrame. Trigger for GoFrame-backed Go work such as APIs/controllers/services, middleware, routing/config, ORM/DAO/DO/entity/database operations, gf CLI/codegen, HTTP/gRPC services, and microservice conventions. Do not trigger for generic Go projects without GoFrame evidence, frontend-only work, shell scripts, or unrelated infrastructure tasks.

Ask your Agent

Use this Skill: https://skilld.dev/gh/gogf/skills/goframe-v2

This session only. Nothing lands on disk.

referencesWEB服务开发路由管理路由管理-路由注册路由注册-规范路由规范路由-常见问题.md

在规范路由下，同一接口如何支持多种 HTTP Method 提交方式

首先，一个接口应当只做一件事情， HTTP Method 是有意义的（例如 RESTful 接口风格设计），一个接口支持多种 HTTP Method 方式通常是接口设计不合理，建议重新审视接口设计。

通常是不存在一个 API 需要绑定多个 HTTP Method 的场景的。例如，拿用户接口来讲，一个 CRUD 接口在 RESTful 实现应当有 4-5 个 API 定义，实现不同的业务逻辑。那么可能存在以下 API 定义的 RESTful 接口：

接口名称    Method    Path
创建用户    PUT       /user
用户列表    GET       /user
用户详情    GET       /user/{uid}
修改用户    POST      /user/{uid}
删除用户    DELETE    /user/{uid}

如果确实存在一个接口支持多个 HTTP Method 的场景，那么可以通过在 Meta 标签中的 method 属性中使用英文 , 号分隔各个 HTTP Method 即可，例如：

type SaveReq struct {
    g.Meta `path:"/user/{uid}" method:"put,post" summary:"保存用户" tags:"用户管理"`
    Uid    int64  `dc:"用户ID"`
    Name   string `dc:"用户名"`
    // ...
}

使用默认提供的 Response 结构体，如何让 Data 字段只返回数组而无需指定名称的键值对

使用类型别名即可。

源码地址：JSON数组响应

结果示例：

Source: SKILL.md on GitHub

Third-party checks

1 alert16d5 checks · Risk MEDIUM
  • Gen Agent Trust Hub16d

    The skill provides a comprehensive development guide and code examples for the GoFrame v2 framework. While highly informative for Go developers, it contains several examples with hardcoded placeholder secrets, tokens, and specific local file paths to sensitive configuration files (like Kubernetes credentials). These elements are provided for demonstration purposes but represent insecure practices if used in production without modification.

  • Socket16d

    5 alerts: gptSecurity, gptAnomaly

  • Snyk16d

    Risk: LOW · No issues

  • Runlayer6mo

    227/949 files flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Provenance

Signed by skilld at 911705d. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 4 months ago.

Steadyupdated 4 months ago

Topics

  • Go
  • Database
  • goframe
  • orm
  • http
  • grpc
  • microservices
  • crud
  • scaffolding
  • middleware

README badge

README badge for gogf/skills

What it does

Provides instruction and conventions for developing with GoFrame v2, a modular Go framework for building HTTP and gRPC services, microservices, and database operations using its ORM, CLI tooling, and project scaffolding. Use this skill when the target project has GoFrame v2 as a dependency or when the user requests scaffolding, migrations, or service development with GoFrame conventions.

Generated from the current SKILL.md.

Frequently asked

When should I use this skill?
Use this skill only when your Go project uses GoFrame v2, indicated by github.com/gogf/gf/v2 in go.mod or imports. Do not use for generic Go projects, frontend work, or infrastructure tasks unrelated to GoFrame.
Should I manually set created_at and updated_at fields?
No. GoFrame automatically writes created_at on insert and updated_at on insert/update/save. Manually setting these fields is redundant and violates project conventions.
What should I use for database operations instead of g.Map?
Always use DO objects from internal/model/do/. DO struct fields are interface{}, unset fields remain nil and are automatically ignored by the ORM.
How does soft delete work in GoFrame?
Call Delete() on the DAO; GoFrame automatically converts it to UPDATE SET deleted_at = NOW(). Queries automatically filter out soft-deleted rows without requiring manual WhereNull conditions.
Where should I implement business logic?
Implement business logic directly in the service/ directory. Do not use the logic/ directory unless explicitly requested.

Generated from the current SKILL.md. These answers refresh after source changes.