sync-api-docs

An API documentation generator for the go-hichat-api project. An API is the set of routes and data formats that software exposes for other software to use.

In plain words
What is it for?
Use it to find every API definition under apps, extract services, routes, authentication requirements, handlers, requests, responses, and types, then write the complete Chinese reference to docs/api.md.
Why use it?
It keeps the reference document synchronized with the project’s Go-Zero API definition files instead of relying on manually copied route and type information.

Command for Claude Code

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add commands/iceymoss/go-hichat-api/sync-api-docs
Clone the repo
git clone --depth 1 https://github.com/iceymoss/go-hichat-api

Made for: Claude Code.

Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 730 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00730
Opus 5 $0.00000 $0.00365
Sonnet 5 $0.00000 $0.00146
Haiku 4.5 $0.00000 $0.00073

Measured 2d ago against content hash cf304d4d35ae, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

sync-api-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude/commands/sync-api-docs.md · 83 lines

How it starts

The opening of the file, as written. The whole thing — 83 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Sync API Documentation

You are an API documentation generator for the go-hichat-api project. Your task is to read all Go-Zero .api definition files and generate a complete, up-to-date API reference document at docs/api.md.

Steps

1. Discover all .api files

Search for all .api files under the apps/ directory:

  • apps/user/api/user.api
  • apps/user/api/domain.api
  • apps/social/api/social.api
  • apps/im/api/im.api
  • apps/trend/api/trend.api
  • Any other .api files that may have been added

Read every .api file found.

2. Parse and extract

From each .api file, extract:

  • Service info: title, author, version from the info() block
  • Routes: HTTP method, path, prefix, group, JWT requirement, @doc description, handler name, request type, response type
  • Type definitions: all type blocks including struct fields, JSON tags, comments, and optional markers

3. Generate docs/api.md

Generate a well-structured Chinese-language Markdown document with the following format:

# HiChat API Reference

> Auto-generated from `.api` definition files. Do not edit manually.
> Last synced: {current date YYYY-MM-DD}

## Table of Contents
(auto-generate based on services)

---

## User Service (`/api/v1/user`)

### POST /api/v1/user/register - User Registration
(description from @doc)

**Auth:** None / JWT Required

**Request Body:**
| Field | Type | Required | JSON Key | Description |
|-------|------|----------|----------|-------------|
| ... | ... | ... | ... | (from comments) |

**Response:**
| Field | Type | JSON Key | Description |
|-------|------|----------|-------------|
| ... | ... | ... | ... |

---
(repeat for each endpoint)

4. Documentation rules

  • Group endpoints by service (User, Social, IM, Trend)
  • Within each service, group by functional module (e.g., Friend management, Group management, Comment, Like)
  • For each endpoint include: HTTP method, full path (prefix + path), description (@doc), auth requirement, request fields, response fields
  • Mark fields as Required or Optional based on the optional tag in the .api file
  • Include field comments from the .api file as description
  • Include shared/common type definitions (like User, Friends, Groups, Discuss, Like, ChatLog, Conversation, etc.) in a separate Data Models section at the end
  • Use Chinese for descriptions where the source .api comments are in Chinese
  • For enum-like fields (e.g., sex: 0-unknown, 1-male, 2-female), include the value mapping from comments

Read the full file on GitHub · 83 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 83 lines · 0 tokens per session scan A cf304d4d35ae

Subscribe to this mod's changes

sync-api-docs is a command published in the GitHub repository iceymoss/go-hichat-api (41 stars, last pushed 1mo ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 730 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.