api-to-doc

Convert API documentation from URLs or HTML into OpenAPI 3.0.0 YAML specifications.

Updated Feb 10, 2026
One-click install
npx skills add https://github.com/miguelfg/api-to-cli-skillset --skill api-to-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-to-doc
Source: https://github.com/miguelfg/api-to-cli-skillset/tree/main/skills/api-to-doc
Command: npx skills add https://github.com/miguelfg/api-to-cli-skillset --skill api-to-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires PyYAML, requests, beautifulsoup4, playwright, lxml, and includes scripts (resource) and references (resource) and assets (resource) components.

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.

Frequently Asked Questions about api-to-doc

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

FAQPage Schema
How do I generate an OpenAPI YAML specification from existing HTML API documentation?

You can generate an OpenAPI YAML specification from HTML API documentation by using automated extraction tools that parse endpoints, parameters, and examples via pattern matching and web scraping. This process converts unstructured HTML into a structured OpenAPI 3.0.0 YAML file.

Can I automatically convert a Swagger URL into an OpenAPI 3.0.0 spec?

Yes, you can automatically convert a Swagger URL into an OpenAPI 3.0.0 spec. The process includes auto-detection of existing OpenAPI or Swagger specifications directly from the provided URL and converts them into the target YAML format.

Does multi-page crawling work for extracting endpoints from large API documentation sites?

Multi-page crawling works for extracting endpoints from large API documentation sites. It enables comprehensive documentation coverage by navigating across multiple pages to gather all available endpoints, parameters, and examples before generating the final YAML output.

What is the best way to extract API endpoints and parameters from web documentation without manual entry?

The best way to extract API endpoints and parameters without manual entry is using intelligent extraction with web scraping and pattern matching. This approach automatically identifies and structures endpoints, parameters, and examples from URLs or HTML.

Are there quality gates for validating extracted endpoints during OpenAPI YAML generation?

Quality gates are included for validating extracted endpoints during OpenAPI YAML generation. These built-in validation checks ensure the accuracy and structural integrity of the endpoints, parameters, and examples extracted from the source documentation.