How do I install the Openapi Workflow skill?

Run npx skillmds add majiayu000/openapi-workflow in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Openapi Workflow safe to use?

This skill has not completed SkillMD's automated safety review yet. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Openapi Workflow?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Openapi Workflow free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Openapi Workflow?

majiayu000 (@majiayu000) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Openapi Workflow by majiayu000 — Agent Skill

Name: Openapi Workflow
Rating: 4.5 (4 reviews)
Author: majiayu000

File contents

OpenAPI Workflow Skill

Automatically runs the OpenAPI workflow when spec files are modified.

When to Activate

This skill should activate when:

Files in backend/api/*.yaml are modified
New endpoints are added to OpenAPI spec
Request/response schemas are changed
User asks to add/modify API endpoints

OpenAPI Spec Location

Type	Path	Purpose
API Spec	`backend/api/openapi.yaml`	Public API definition

Workflow Steps

1. Validate Spec

python3 scripts/openapi_workflow.py --validate

2. Generate Code (All Platforms)

python3 scripts/openapi_workflow.py --codegen

This generates:

Backend (Go): backend/internal/generated/
iOS (Swift): mobile/ios/App/Generated/
Android (Kotlin): mobile/android/app/src/main/java/.../generated/
Web (TypeScript): web/src/generated/

3. Build Verification

python3 scripts/openapi_workflow.py --build

4. Full Workflow (All Steps)

python3 scripts/openapi_workflow.py --full

Critical Rules

Rule	Why
Define response schemas properly	Inline schemas don't generate reusable types
Use plural file names	REST convention: `users.yaml` not `user.yaml`
Always regenerate after spec changes	Generated code must match spec
Verify ALL platforms build	API changes affect backend + iOS + Android + web

Process

Detect OpenAPI spec was modified
Run validation to catch syntax/semantic errors
Regenerate code for all platforms
Run build verification
Report any failures

Output Format

## OpenAPI Workflow Results

**Spec Modified**: [file path]
**Validation**: ✅ Passed / ❌ Failed
**Code Generation**: ✅ All platforms / ❌ Failed for [platform]
**Build Verification**: ✅ All platforms / ❌ Failed for [platform]

[Details of any failures]

Reference

Script: scripts/openapi_workflow.py
Spec: backend/api/openapi.yaml

---name: openapi-workflowdescription: Proactive OpenAPI workflow. Triggers when OpenAPI spec files are modified to validate, regenerate code, and verify builds.--- # OpenAPI Workflow Skill Automatically runs the OpenAPI workflow when spec files are modified. ## When to Activate This skill should activate when: - Files in `backend/api/*.yaml` are modified - New endpoints are added to OpenAPI spec - Request/response schemas are changed - User asks to add/modify API endpoints ## OpenAPI Spec Location | Type | Path | Purpose | |------|------|---------| | API Spec | `backend/api/openapi.yaml` | Public API definition | ## Workflow Steps ### 1. Validate Spec ```bash python3 scripts/openapi_workflow.py --validate ``` ### 2. Generate Code (All Platforms) ```bash python3 scripts/openapi_workflow.py --codegen ``` This generates: - **Backend (Go)**: `backend/internal/generated/` - **iOS (Swift)**: `mobile/ios/App/Generated/` - **Android (Kotlin)**: `mobile/android/app/src/main/java/.../generated/` - **Web (TypeScript)**: `web/src/generated/` ### 3. Build Verification ```bash python3 scripts/openapi_workflow.py --build ``` ### 4. Full Workflow (All Steps) ```bash python3 scripts/openapi_workflow.py --full ``` ## Critical Rules | Rule | Why | |------|-----| | Define response schemas properly | Inline schemas don't generate reusable types | | Use plural file names | REST convention: `users.yaml` not `user.yaml` | | Always regenerate after spec changes | Generated code must match spec | | Verify ALL platforms build | API changes affect backend + iOS + Android + web | ## Process 1. Detect OpenAPI spec was modified 2. Run validation to catch syntax/semantic errors 3. Regenerate code for all platforms 4. Run build verification 5. Report any failures ## Output Format ``` ## OpenAPI Workflow Results **Spec Modified**: [file path] **Validation**: ✅ Passed / ❌ Failed **Code Generation**: ✅ All platforms / ❌ Failed for [platform] **Build Verification**: ✅ All platforms / ❌ Failed for [platform] [Details of any failures] ``` ## Reference - Script: `scripts/openapi_workflow.py` - Spec: `backend/api/openapi.yaml`

Frequently asked questions