parse-swagger-lite
Parse Swagger/OpenAPI documents quickly to extract basic information. Ideal for handling large files, with options to include schemas, details, and filter by tags or paths.
Instructions
Lightweight parsing of Swagger/OpenAPI document, faster but returns only basic information (suitable for large documents).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cacheTTLMinutes | No | Cache TTL in minutes | |
| filterTag | No | Filter operations by tag | |
| headers | No | Request headers | |
| includeDetails | No | Whether to include all details like request bodies, responses, etc. | |
| includeSchemas | No | Whether to include schema definitions | |
| lazyLoading | No | Whether to use lazy loading for schema parsing | |
| pathPrefix | No | Filter operations by path prefix | |
| skipValidation | No | Whether to skip validation, used for handling non-fully compliant API documents | |
| url | Yes | Swagger/OpenAPI document URL | |
| useCache | No | Whether to use cache |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cacheTTLMinutes": {
"description": "Cache TTL in minutes",
"type": "number"
},
"filterTag": {
"description": "Filter operations by tag",
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "Request headers",
"type": "object"
},
"includeDetails": {
"description": "Whether to include all details like request bodies, responses, etc.",
"type": "boolean"
},
"includeSchemas": {
"description": "Whether to include schema definitions",
"type": "boolean"
},
"lazyLoading": {
"description": "Whether to use lazy loading for schema parsing",
"type": "boolean"
},
"pathPrefix": {
"description": "Filter operations by path prefix",
"type": "string"
},
"skipValidation": {
"description": "Whether to skip validation, used for handling non-fully compliant API documents",
"type": "boolean"
},
"url": {
"description": "Swagger/OpenAPI document URL",
"type": "string"
},
"useCache": {
"description": "Whether to use cache",
"type": "boolean"
}
},
"required": [
"url"
],
"type": "object"
}