Token导航 LogoToken导航TokenDH.com
前端设计需要联网github未标认证来源可访问许可证需确认审计通过

api-style-guideAPI style 指南

Agent Skill

用于辅助 API 设计、接口文档、请求响应结构和服务集成说明。它适合让 Agent 梳理 endpoint、生成 OpenAPI 草稿、检查字段命名、整理错误码或辅助前后端联调。使用时需要确认真实业务语义、鉴权方式、分页和错误处理规则;涉及生成接口文档时,应避免凭空补字段,最好从现有代码、schema 或接口样例中提取事实。

总安装

768

周安装

33

GitHub Stars

177

下载量

269
CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

GitHub

来源数

2

许可证

unknown

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手,先确认命令和权限,再让它执行。

请帮我安装这个 Agent Skill:api-style-guide(API style 指南)
来源仓库:https://github.com/gtmagents/gtm-agents
仓库路径:skills/api-style-guide
安装命令:
npx skills add https://github.com/gtmagents/gtm-agents --skill api-style-guide
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 npx skills 从第三方来源获取 Skill;本站只展示命令,不托管安装包,也不自动执行。

skills.shnpx skills
npx skills add https://github.com/gtmagents/gtm-agents --skill api-style-guide

简介

用于编写和维护 API 参考文档、教程与 SDK 说明,保证内容一致性。

  • 提供端点顺序约定、表格布局与代码块格式化标准,提升可读性。
  • 支持多语言术语管理与禁用短语列表,适配不同受众群体需求。
  • 安装方式:通过 GitHub 仓库安装,命令为 npx skills add <repo> --skill api-style-guide。
  • 适用于文档审核与发布前审计,确保对外交付材料符合品牌规范。

SKILL.md

API Style Guide Skill

When to Use

  • Authoring or updating API references, tutorials, and SDK docs.
  • Reviewing contributions from engineers, DevRel, or partners.
  • Auditing docs for consistency before releases.

Framework

  1. Language & Tone – audience-specific tone, terminology list, and banned phrases.
  2. Structure – endpoint/order conventions, table layouts, code block formatting, error doc patterns.
  3. Code Samples – naming standards, authentication handling, pagination patterns, inline comments.
  4. Metadata & Tags – version labels, availability notes, beta flags, locale indicators.
  5. Accessibility & Localization – heading hierarchy, alt-text, snippet annotations, translation guidance.

Templates

  • Reference entry template (description, parameters, responses, examples, notes).
  • Tutorial skeleton with prerequisites, steps, troubleshooting, next steps.
  • Code sample checklist ensuring env vars, comments, and error handling are included.

Tips

  • Keep examples runnable; provide curl equivalents even when primary sample is in another language.
  • Link to glossary for shared terminology across teams.
  • Pair with update-api-reference command to enforce consistent output.

适合场景

01

用户想查找某类 Agent Skill 时

02

需要根据任务场景推荐可安装能力包时

03

需要对比不同来源的安装命令和来源信息时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明,方便继续核验

能力 4

展示第三方安全扫描或审计结果

安装后应在对应宿主中按原始 README 的触发条件使用;具体调用方式请以来源页面和 README 为准。

平台分布

Codex

35.04%
按下载量换算94

Claude

33.54%
按下载量换算90

Cursor

18.85%
按下载量换算51

Gemini CLI

9.48%
按下载量换算26

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

通过

权限和风险

需要联网

该 Skill 可能需要联网访问来源站点、仓库或外部 API;具体网络访问范围需要结合源码和 README 复核。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。当前只有一个来源,正式发布前建议补源仓库或其他目录站核验。

来源信息

继续浏览同类 Skills