api-to-doc

Community

Convert API docs to OpenAPI YAML

Authormiguelfg
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill automates the creation of OpenAPI 3.0.0 YAML specifications from various API documentation sources, eliminating the need for manual specification writing.

Core Features & Use Cases

  • Automated OpenAPI Generation: Converts API URLs, HTML documentation, or existing specs into a structured OpenAPI YAML file.
  • Intelligent Extraction: Extracts endpoints, parameters, and examples using pattern matching and web scraping techniques.
  • Use Case: You have a REST API with HTML documentation. Use this Skill to generate an OpenAPI spec, which can then be used by downstream Skills to create API client libraries or documentation.

Quick Start

Use the api-to-doc skill to convert the API documentation found at 'https://petstore.swagger.io' into an OpenAPI YAML file.

Dependency Matrix

Required Modules

PyYAMLrequestsbeautifulsoup4playwrightlxml

Components

scriptsreferencesassets

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: api-to-doc
Download link: https://github.com/miguelfg/api-to-cli-skillset/archive/main.zip#api-to-doc

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.