ZG
gi-ink Modular Go API scaffold for real product work
Running PRODUCTION
Base URL https://z.gi.ink
Pure Go API scaffold

Start shipping backend work without rebuilding auth, API keys, or CLI plumbing.

This homepage is here to answer the first three developer questions fast: did the service boot correctly, what ships by default, and what should I do next.

Open Swagger Read GitHub Docs Check Health
Default starters User auth, API keys, and audit logging are already wired.
CLI seam Generation, migration, and AI commands share one manifest surface.
Extension path Add modules behind starter manifests instead of editing five boot files.

Get productive in three moves

首页不该把所有能力平铺出来。对新启动的项目，最关键的是确认服务、探索接口、然后开始改代码。

Step 01

Verify the service

先确认服务真的在跑，环境值加载正常，数据库和中间件链没有阻断启动。

GET https://z.gi.ink/v1/health
Step 02

Explore the default API

默认 scaffold 已经带了认证、API key 管理和全局审计。优先通过 Swagger 看清现成 surface，再决定加什么 starter。

open https://z.gi.ink/swagger/index.html
Step 03

Generate the next module

从完整模块脚手架起步，而不是零散补文件。单文件生成命令只用来修复现有模块，不用来起新模块。

go run ./cmd/luas make:module Invoice

What ships in the default scaffold

这里展示的是现在真正可用的 product surface，不再混入已经被移除的部署平台或控制面业务。

Starter

User auth

注册、登录、JWT 鉴权、当前用户资料和密码相关流程。适合作为几乎所有后台项目的最小业务起点。

Starter

API key access

机器访问场景的 key 创建、列表、撤销和中间件组。默认 scaffold 已经能服务自动化调用和服务到服务请求。

Starter

Audit logging

默认对写请求做全局审计，并给当前用户提供历史查询接口。这样安全回溯不再是业务项目后补的一层。

Know the shape of the app

这是给 PM、Tech Lead 和新开发者的架构地图。首页应该帮助人形成 mental model，而不是只堆 feature badge。

Core

Runtime and infra

Bootstrap、router、response、migration、testing 和 shared packages. 这些是每个 Luas 应用都会用到的底层能力。

Starter

Business-ready defaults

user、apikey 和 audit 默认装配到新应用。它们通过 starter manifest 贡献模块、迁移和 seed。

Capability

Reusable technical seams

像 AI 这种技术能力留在 capability 层，避免把外部集成和业务对象混成一个宽模块。

Optional starter

Keep expansion explicit

RBAC 一类增强模块可以保留，但不会默认侵入 scaffold 主链。这样主仓库保持纯净，扩展也更诚实。

Default endpoints

Ready-to-call routes

这些是启动后最值得先验证的接口，能快速确认默认 starter 的行为面是否健康。

  • POST/v1/register
  • POST/v1/login
  • GET/v1/users/profile
  • GET/v1/api-keys
  • GET/v1/audit-logs
  • GET/v1/health
Direct links

Fast paths for the next click

把真正有决策价值的入口放在这里。不是所有链接都要上首页，只有最可能成为下一步动作的才应该出现。