Token导航 LogoToken导航

Agent Skill · 开发

openapi-specification-v2(OpenAPI 规范 v2)

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

openapi-specification-v2 是开发类 Agent Skill,可用宿主为 Codex、Claude、Cursor、Gemini CLI,通过GitHub 仓库获取,权限为接触敏感数据;许可证信息还不明确,第三方扫描已通过,按安装量在开发类的 21,746 个 Skill 里排第 3,816。

总安装 10,057周安装 432GitHub Stars 15下载 3,525核验 2026-05-01

安装说明

本站只整理中文说明,不托管安装包,也不代用户安装。
GitHub
许可证
unknown

安装方式

通过对话安装

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

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

命令行安装

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

skills.shnpx skills
npx skills add https://github.com/hairyf/skills --skill openapi-specification-v2

这个 Skill 是做什么的

开发类 Skill 面向写代码、改代码和排查问题,一般会读写仓库文件,部分还会执行构建或测试命令。

有关编写、验证和解释 OpenAPI 规范 2.0 (Swagger) 文档的完整参考。

涵盖所有核心模式元素:Swagger 对象根、信息/联系人/许可证元数据、路径、操作、参数(路径、查询、标头、正文、formData)、响应以及具有组合和多态性支持的模式 包括基本身份验证、API 密钥和 OAuth2 流(隐式、密码、应用程序、accessCode)的安全定义以及范围和要求对象 提供 $ref 使用、JSON 指针、外部文件引用和根级参数/响应/架构重用的参考指南 地址数据类型、格式、MIME 类型、HTTP 状态代码、路径模板、标头和供应商扩展(x- 前缀) 包括操作 ID、标签、响应和规范创作模式的最佳实践

来源仓库内路径:skills/openapi-specification-v2

上手步骤

4 步
  1. 1

    确认自己的宿主工具

    公开资料标注支持 Codex、Claude、Cursor、Gemini CLI;先确认自己用的是其中之一,再按对应工具的 Skills 目录放置。

  2. 2

    拿到安装命令

    可以直接复制的命令是 npx skills add https://github.com/hairyf/skills --skill openapi-specification-v2;命令里的占位符换成自己的路径或密钥再执行。

  3. 3

    安装后重启宿主

    命令执行完要完全退出宿主工具再打开,让新装的 Skill 被重新扫描到,否则列表里可能看不到。

  4. 4

    按最小权限试用

    它需要接触敏感数据,先在测试目录或测试账号里跑,确认没问题再放到正式项目。

常见问题

6 条

openapi-specification-v2 怎么安装?

在终端执行 npx skills add https://github.com/hairyf/skills --skill openapi-specification-v2。装完完全退出宿主工具再打开,让它重新扫描本地 Skill。

openapi-specification-v2 支持哪些 AI 工具?

公开资料标注支持 Codex、Claude、Cursor、Gemini CLI。其他工具只要能读取本地 Skill 目录,一般也能手动放进去,但要自己确认触发方式是否一致。

openapi-specification-v2 需要什么权限?

权限级别是接触敏感数据。该 Skill 可能接触密钥、Token、环境变量或敏感配置,应进入高风险复核队列,默认不自动发布。

openapi-specification-v2 是免费的吗?

公开资料没有标注明确许可证,收费和商用限制都无法确认。正式使用前请到来源仓库核对授权说明。

openapi-specification-v2 用的人多吗?

公开数据是累计安装 10,057 次,近一周安装 432 次,下载 3,525 次,GitHub 15 星。这些数字来自第三方目录统计,只能当作热度参考,不代表质量或安全性。

openapi-specification-v2 安全吗?

第三方扫描结果为通过,但这只覆盖已知的静态检查项,不能替代自己读一遍源码和安装命令。

值得选的地方和要先想清楚的地方

值得选的地方

  • 同时适配 4 种工具,换客户端不用重新找替代品。
  • 第三方扫描已通过,常见的高风险行为没有命中。

先想清楚的地方

  • 需要接触敏感数据,装到常用环境前要先评估影响面。
  • 许可证没有明确标注,能不能商用、能不能再分发都不确定。
  • 第三方目录整理,版本更新和行为细节以来源仓库为准。

适不适合你

更适合

  • 已经在用 Codex,想直接扩展它能力的人。
  • 需要处理开发类任务、又不想每次都手写提示词的人。

不太适合

  • 环境里有大量密钥、凭证,不方便给第三方 Skill 读取的人。
  • 需要明确授权才能用到公司项目里的场景。
  • 需要厂商级技术支持和 SLA 的生产系统。

开发类 Skill 对比

6 个同类
Skill总安装GitHub 星权限许可证扫描
skill-vetter

技能审查员 · OpenClaw

8,779,018986操作浏览器MIT-0通过
ontology

本体论 · OpenClaw

6,636,960576只读MIT-0通过
entra-app-registration

内部应用程序注册 · Codex、Claude

6,631,872764接触敏感数据未明确通过
entra-app-registration

内部应用程序注册 · Codex、Claude

3,757,680201接触敏感数据未明确通过
nano-banana-pro

纳米香蕉专业版 · OpenClaw

3,526,898364接触敏感数据MIT-0有提醒
openapi-specification-v2

OpenAPI 规范 v2 · 本页

10,05715接触敏感数据未明确通过

按安装量取同分类前几名;数字来自第三方目录统计,只作热度参考,不代表质量结论。

SKILL.md 原文

OpenAPI Specification 2.0 (formerly Swagger 2.0) defines a JSON/YAML format for describing RESTful APIs: paths, operations, parameters, responses, schemas, and security. Use this skill when creating or editing Swagger 2.0 specs, validating structure, or generating code/documentation from them.

The skill is based on OpenAPI Specification 2.0, generated at 2026-01-30.

Core References

TopicDescriptionReference
Format and StructureDocument format, file structure, data typescore-format-and-structure
Fixed and Patterned FieldsFixed vs patterned field names in the schemacore-fixed-patterned-fields
Swagger ObjectRoot document, required/optional fields, extensionscore-swagger-object
Info and MetadataInfo, Contact, License objectscore-info-metadata
Tags and External DocsTag Object, External Documentation Objectcore-tags-and-external-docs
Reference Object$ref, JSON Pointer, same-document and external file referencescore-reference-object
Data Types and FormatsPrimitives, format table, validation, file typecore-data-types-and-formats
MIME Typesconsumes/produces, RFC 6838, examplescore-mime-types
HTTP Status CodesResponse keys, default response, IANA/RFC 7231core-http-status-codes
Path TemplatingCurly braces, path parameters, name matchingcore-path-templating
Header ObjectResponse header definition (type, format, items, validation)core-header-object
Headers ObjectContainer for response headers (name → Header Object)core-headers-object
Items ObjectNon-body array items (parameters, headers)core-items-object
Example ObjectResponse examples by MIME typecore-example-object

Paths and Operations

TopicDescriptionReference
Paths and OperationsPaths Object, Path Item, Operation Objectpaths-and-operations
Path Item $refExternal path definition, conflict behaviorpath-item-ref

Parameters and Responses

TopicDescriptionReference
ParametersParameter locations (path, query, header, body, formData)parameters
collectionFormatcsv, ssv, tsv, pipes, multi and where they applyparameters-collection-format
Parameters Definitions (Reuse)Root-level parameters, reuse via $refparameters-definitions-reuse
ResponsesResponses Object, Response Objectresponses
Responses Definitions (Reuse)Root-level responses, reuse via $refresponses-definitions-reuse

Schemas and Definitions

TopicDescriptionReference
Schema and DefinitionsSchema Object, Definitions, composition, polymorphismschema-and-definitions
Schema JSON Schema KeywordsJSON Schema Draft 4 subset and Swagger-specific fieldsschema-json-schema-keywords

Security

TopicDescriptionReference
SecuritySecurity Definitions, Security Schemesecurity
Security Requirement ObjectApplying security at root/operation, OR/AND logicsecurity-requirement-object
Scopes ObjectOAuth2 scope name → descriptionsecurity-scopes-object
Basic and API Keybasic and apiKey Security Schemesecurity-basic-apikey
OAuth2 Flowsimplicit, password, application, accessCode and required URLssecurity-oauth2-flows

Best Practices

TopicDescriptionReference
Spec AuthoringoperationId, tags, responses, parameters, definitions, securitybest-practices-spec-authoring

Advanced

TopicDescriptionReference
Vendor Extensionsx- prefix, value types, where allowedadvanced-vendor-extensions
Security FilteringEmpty Paths, empty Path Item for access controladvanced-security-filtering
Extensions and XMLXML Object for schema propertiesadvanced-extensions-and-xml

平台分布

Codex

36.33%
按下载量换算1,281

Claude

31.01%
按下载量换算1,093

Cursor

20.92%
按下载量换算737

Gemini CLI

9.4%
按下载量换算331

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

通过

权限和风险

接触敏感数据

该 Skill 可能接触密钥、Token、环境变量或敏感配置,应进入高风险复核队列,默认不自动发布。

安装前确认

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

继续浏览同类 Skills