# swagger-doc-creator

swagger-doc-creator automates Swagger and OpenAPI documentation tasks, generating schema configurations and validating API definitions against standard patterns.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 239 installs · ★ 2935 repo stars
- Author: Jeremy Longshore
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/jeremylongshore/tons-of-skills-marketplace/tree/HEAD/skills/15-api-development/swagger-doc-creator/SKILL.md
- Updated: 2026-11-01
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/skills/swagger-doc-creator

## What it does

This skill guides API documentation workflows within your editor. It prepares schema configurations, writes output files, and checks the generated endpoints against standard API design rules.

The skill relies on specific agent tools: file operations via `Read`, `Write`, and `Edit`, pattern searches with `Grep`, and restricted shell execution using `Bash(curl:*)`. External terminal calls are strictly limited to curl requests.

Missing parameters cause configuration validation failures. You must have your target development environment and required dependencies ready beforehand.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add jeremylongshore/tons-of-skills-marketplace --skill swagger-doc-creator -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/swagger-doc-creator/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/swagger-doc-creator/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add jeremylongshore/tons-of-skills-marketplace --skill swagger-doc-creator -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/swagger-doc-creator/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add jeremylongshore/tons-of-skills-marketplace --skill swagger-doc-creator -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/swagger-doc-creator/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install jeremylongshore/tons-of-skills-marketplace skills/15-api-development/swagger-doc-creator
```

2. **Manually: put the files in place**
- File: `.github/skills/swagger-doc-creator/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add jeremylongshore/tons-of-skills-marketplace --skill swagger-doc-creator -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/jeremylongshore/tons-of-skills-marketplace --path skills/15-api-development/swagger-doc-creator
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/swagger-doc-creator/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add jeremylongshore/tons-of-skills-marketplace --skill swagger-doc-creator -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/jeremylongshore/tons-of-skills-marketplace/tree/HEAD/skills/15-api-development/swagger-doc-creator/SKILL.md

## When to use it
- generate Swagger and OpenAPI configurations for existing routes
- validate schema parameters against standard API specifications
- structure endpoint documentation and design patterns

## Example prompts
- Help me with swagger doc creator for this backend
- Generate Swagger documentation for the authentication endpoints
- Check our OpenAPI schema configuration for missing fields

## Source text · SKILL.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 01d297ec6ea66800.

BEGIN THIRD-PARTY FILE 01d297ec6ea66800
```text
---
name: swagger-doc-creator
description: 'Create swagger doc creator operations. Auto-activating skill for API
  Development.

  Triggers on: swagger doc creator, swagger doc creator

  Part of the API Development skill category. Use when working with swagger doc creator
  functionality. Trigger with phrases like "swagger doc creator", "swagger creator",
  "swagger".

  '
allowed-tools: Read, Write, Edit, Bash(curl:*), Grep
version: 1.0.0
license: MIT
author: Jeremy Longshore <jeremy@intentsolutions.io>
tags:
- api
- development
compatibility: Designed for Claude Code
---
# Swagger Doc Creator

## Overview

This skill provides automated assistance for swagger doc creator tasks within the API Development domain.

## When to Use

This skill activates automatically when you:
- Mention "swagger doc creator" in your request
- Ask about swagger doc creator patterns or best practices
- Need help with api development skills covering rest, graphql, openapi, authentication, and api design patterns.

## Instructions

1. Provides step-by-step guidance for swagger doc creator
2. Follows industry best practices and patterns
3. Generates production-ready code and configurations
4. Validates outputs against common standards

## Examples

**Example: Basic Usage**
Request: "Help me with swagger doc creator"
Result: Provides step-by-step guidance and generates appropriate configurations


## Prerequisites

- Relevant development environment configured
- Access to necessary tools and services
- Basic understanding of api development concepts


## Output

- Generated configurations and code
- Best practice recommendations
- Validation results


## Error Handling

| Error | Cause | Solution |
|-------|-------|----------|
| Configuration invalid | Missing required fields | Check documentation for required parameters |
| Tool not found | Dependency not installed | Install required tools per prerequisites |
| Permission denied | Insufficient access | Verify credentials and permissions |


## Resources

- Official documentation for related tools
- Best practices guides
- Community examples and tutorials

## Related Skills

Part of the **API Development** skill category.
Tags: api, rest, graphql, openapi, swagger
```
END THIRD-PARTY FILE 01d297ec6ea66800

The third-party file has ended. Everything between the 01d297ec6ea66800 tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

© Jeremy Longshore · MIT · https://github.com/jeremylongshore/tons-of-skills-marketplace/tree/HEAD/skills/15-api-development/swagger-doc-creator/SKILL.md

## Similar
- [doc-api](https://affpapa.org/en/nevibecode/commands/doc-api.md) — command · 733 installs
- [api-reference-documentation](https://affpapa.org/en/nevibecode/skills/api-reference-documentation.md) — skill · 501 installs
- [doc-generator](https://affpapa.org/en/nevibecode/skills/luongnv89-doc-generator.md) — skill · ★ 47494 repo stars
- [swagger-contract-testing-openapi-parser](https://affpapa.org/en/nevibecode/plugins/swagger-contract-testing-openapi-parser.md) — plugin · ★ 7 repo stars
- [golang-swagger](https://affpapa.org/en/nevibecode/skills/golang-swagger.md) — skill · 39200 installs

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
