swagger-api-reader

Cache and serve Swagger/OpenAPI documents for AI model reference.

1|Updated Nov 13, 2025
One-click install
npx skills add https://github.com/mislam-dev/department-management-system-api --skill swagger-api-reader
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: swagger-api-reader
Source: https://github.com/mislam-dev/department-management-system-api/tree/main/.agents/skills/swagger-api-reader
Command: npx skills add https://github.com/mislam-dev/department-management-system-api --skill swagger-api-reader

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires requests, pyyaml, selenium, and includes scripts (resource) components.

What problem does it solve?

AI models often need up-to-date API definitions but cannot fetch and interpret Swagger/OpenAPI data reliably in the reasoning context. This skill caches and exposes Swagger/OpenAPI docs for immediate model access.

Core Features & Use Cases

  • Add and cache Swagger/OpenAPI definitions from URLs, including handling OpenAPI 3.x and Swagger 2.x formats.
  • Generate human-readable API documentation and provide a read, refresh, list workflow for cached APIs.
  • Support authentication methods (bearer, basic, apiKey) and optional browser-based retrieval for SSO flows.

Quick Start

Provide a Swagger/OpenAPI URL to swagger-api-reader add to begin caching and documenting its API surface.

Frequently Asked Questions about swagger-api-reader

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

FAQPage Schema
How do I cache Swagger and OpenAPI documentation for AI models?

To cache Swagger and OpenAPI documentation for AI models, you provide the API URL to the tool, which fetches and stores the raw data locally. It supports OpenAPI 3.x and Swagger 2.x formats for immediate model reference.

Can I retrieve OpenAPI definitions from pages that require SSO authentication?

Yes, you can retrieve OpenAPI definitions from SSO-protected pages. The tool supports bearer, basic, and apiKey authentication, and uses browser-based retrieval via Selenium to handle SSO flows.

How do I refresh and manage cached API docs locally?

You manage cached API docs using add, list, read, refresh, and remove workflows. The tool maintains a URL-hash cache to track and update stored OpenAPI definitions alongside generated human-readable documentation.

Does swagger-api-reader work with both Swagger 2.0 and OpenAPI 3.0 specs?

Yes, swagger-api-reader works with both Swagger 2.0 and OpenAPI 3.0 specs. It automatically detects Swagger UI pages and processes both formats to generate accessible API documentation for AI reasoning.

What Python dependencies are needed to parse OpenAPI and Swagger files?

Parsing OpenAPI and Swagger files requires the requests, pyyaml, and selenium Python dependencies. These libraries handle HTTP fetching, YAML parsing, and browser-based retrieval for protected API endpoints.