openapi-editor

Edit OpenAPI specifications and trigger Make-based code generation.

Updated Dec 25, 2025
One-click install
npx skills add https://github.com/mktkhr/field-manager-api --skill openapi-editor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: openapi-editor
Source: https://github.com/mktkhr/field-manager-api/tree/main/.claude/skills/openapi-editor
Command: npx skills add https://github.com/mktkhr/field-manager-api --skill openapi-editor

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

OpenAPI仕様を整備・拡張したい開発チームが、エンドポイント追加やスキーマ更新を安全かつ再現性高く行えるようにします。

Core Features & Use Cases

  • エンドポイントの追加・編集を一元管理
  • スキーマの追加・編集をコードと整合させる
  • OpenAPIファイルの作成・更新を自動化
  • Use Case: 新機能リリース時に、API仕様を迅速に反映し、テストとコード生成を連携させる

Quick Start

Edit the health endpoint to include a new field and run the code generation to refresh the OpenAPI artifacts.

Frequently Asked Questions about openapi-editor

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I edit OpenAPI specifications to keep API contracts accurate?

To edit OpenAPI specifications accurately, you update endpoints and schemas across api/paths and api/components while enforcing structured references and language constraints to maintain consistency. This ensures your API contracts stay aligned with implementation.

How do I add a new endpoint to an existing OpenAPI YAML file?

You add a new endpoint by editing the OpenAPI YAML file under api/paths, defining the route and its schema. The Skill manages this centrally so endpoint additions remain consistent and reproducible across your API specification.

What is the best way to align OpenAPI documentation with code generation?

The best way to align OpenAPI documentation with code generation is to trigger Make targets after editing your specification files. This refreshes OpenAPI artifacts and ensures generated code matches the updated API contracts.

Can I update OpenAPI schemas and components without breaking existing references?

Yes, you can update schemas and components safely because the Skill enforces structured references within api/components. This constraint prevents broken links and maintains consistency across your OpenAPI specification.

How do I create a new OpenAPI file from scratch for API design?

You create a new OpenAPI file by defining your initial endpoints and schemas, then running code generation via Make targets. The Skill automates file creation and updates, ensuring your new specification integrates with existing artifacts.