apx-toolkit
Version:
Automatically discover APIs and generate complete integration packages: code in 12 languages, TypeScript types, test suites, SDK packages, API documentation, mock servers, performance reports, and contract tests. Saves 2-4 weeks of work in seconds.
346 lines (345 loc) • 9.35 kB
JSON
{
"actorSpecification": 1,
"title": "APX Toolkit Dataset",
"description": "Dataset schema for APX Toolkit output containing discovered APIs, generated code, documentation, types, tests, SDKs, and extracted data",
"fields": {
"type": "object",
"properties": {
"_type": {
"type": "string",
"title": "Type",
"description": "Type of output item"
},
"sourceUrl": {
"type": "string",
"format": "uri",
"title": "Source URL",
"description": "The page URL where the API was discovered"
},
"apiUrl": {
"type": "string",
"format": "uri",
"title": "API URL",
"description": "The discovered API endpoint URL"
},
"page": {
"type": "integer",
"title": "Page Number",
"description": "Pagination page (if applicable)"
},
"offset": {
"type": "integer",
"title": "Offset",
"description": "Pagination offset (if applicable)"
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp",
"description": "When the API call was made"
},
"extractedAt": {
"type": "string",
"format": "date-time",
"title": "Extracted At",
"description": "When the data was extracted"
},
"method": {
"type": "string",
"title": "Method",
"description": "HTTP method"
},
"statusCode": {
"type": "integer",
"title": "Status Code",
"description": "HTTP status code of the response"
},
"format": {
"type": "string",
"title": "Format",
"description": "Documentation format"
},
"content": {
"type": "string",
"title": "Content",
"description": "Documentation or code content"
},
"language": {
"type": "string",
"title": "Language",
"description": "Programming language"
},
"packageName": {
"type": "string",
"title": "Package Name",
"description": "SDK package name"
},
"totalApis": {
"type": "integer",
"title": "Total APIs",
"description": "Total number of APIs discovered"
},
"generatedAt": {
"type": "string",
"format": "date-time",
"title": "Generated At",
"description": "When the item was generated"
}
},
"additionalProperties": true
},
"views": {
"discoveredApis": {
"title": "Discovered APIs 📡",
"description": "Overview of APIs discovered from start URLs, including endpoints and metadata",
"transformation": {
"fields": ["apiUrl", "sourceUrl", "statusCode", "timestamp", "extractedAt", "page", "offset", "method"]
},
"display": {
"component": "table",
"properties": {
"apiUrl": {
"label": "API URL",
"format": "link"
},
"sourceUrl": {
"label": "Source URL",
"format": "link"
},
"statusCode": {
"label": "Status Code",
"format": "number"
},
"timestamp": {
"label": "Timestamp",
"format": "date"
},
"extractedAt": {
"label": "Extracted At",
"format": "date"
},
"page": {
"label": "Page",
"format": "number"
},
"offset": {
"label": "Offset",
"format": "number"
},
"method": {
"label": "Method",
"format": "text"
}
}
}
},
"extractedData": {
"title": "Extracted Data 📊",
"description": "All extracted data items from discovered APIs",
"transformation": {
"fields": ["_type", "sourceUrl", "apiUrl", "extractedAt"]
},
"display": {
"component": "table",
"properties": {
"_type": {
"format": "text",
"label": "Type"
},
"apiUrl": {
"format": "link",
"label": "API URL"
},
"sourceUrl": {
"format": "link",
"label": "Source URL"
},
"extractedAt": {
"format": "date",
"label": "Extracted At"
}
}
}
},
"codeSnippets": {
"title": "Code Snippets 💻",
"description": "Ready-to-use code snippets in 12 programming languages",
"transformation": {
"fields": ["_type", "sourceUrl", "totalApis", "generatedAt"]
},
"display": {
"component": "table",
"properties": {
"sourceUrl": {
"format": "link",
"label": "Source URL"
},
"totalApis": {
"format": "number",
"label": "Total APIs"
},
"generatedAt": {
"format": "date",
"label": "Generated At"
}
}
}
},
"typescriptTypes": {
"title": "TypeScript Types 📘",
"description": "Complete TypeScript type definitions for all discovered APIs",
"transformation": {
"fields": ["_type", "sourceUrl", "totalApis", "generatedAt"]
},
"display": {
"component": "table",
"properties": {
"sourceUrl": {
"format": "link",
"label": "Source URL"
},
"totalApis": {
"format": "number",
"label": "Total APIs"
},
"generatedAt": {
"format": "date",
"label": "Generated At"
}
}
}
},
"apiDocumentation": {
"title": "API Documentation 📚",
"description": "API documentation in multiple formats (OpenAPI, Postman, cURL, Insomnia)",
"transformation": {
"fields": ["_type", "format", "sourceUrl", "generatedAt"]
},
"display": {
"component": "table",
"properties": {
"format": {
"format": "text",
"label": "Format"
},
"sourceUrl": {
"format": "link",
"label": "Source URL"
},
"generatedAt": {
"format": "date",
"label": "Generated At"
}
}
}
},
"testSuites": {
"title": "Test Suites 🧪",
"description": "Ready-to-run test suites in 5 testing frameworks",
"transformation": {
"fields": ["_type", "sourceUrl", "totalApis", "generatedAt"]
},
"display": {
"component": "table",
"properties": {
"sourceUrl": {
"format": "link",
"label": "Source URL"
},
"totalApis": {
"format": "number",
"label": "Total APIs"
},
"generatedAt": {
"format": "date",
"label": "Generated At"
}
}
}
},
"sdkPackages": {
"title": "SDK Packages 📦",
"description": "Complete SDK packages for TypeScript, Python, and Go",
"transformation": {
"fields": ["_type", "language", "packageName", "sourceUrl", "totalApis", "generatedAt"]
},
"display": {
"component": "table",
"properties": {
"language": {
"format": "text",
"label": "Language"
},
"packageName": {
"format": "text",
"label": "Package"
},
"sourceUrl": {
"format": "link",
"label": "Source URL"
},
"totalApis": {
"format": "number",
"label": "Total APIs"
},
"generatedAt": {
"format": "date",
"label": "Generated At"
}
}
}
},
"apiExamples": {
"title": "API Examples 📝",
"description": "Request/response examples for all discovered APIs",
"transformation": {
"fields": ["_type", "sourceUrl", "totalApis", "generatedAt"]
},
"display": {
"component": "table",
"properties": {
"sourceUrl": {
"format": "link",
"label": "Source URL"
},
"totalApis": {
"format": "number",
"label": "Total Examples"
},
"generatedAt": {
"format": "date",
"label": "Generated At"
}
}
}
},
"executionSummary": {
"title": "Execution Summary 📈",
"description": "Statistics and summary of the Actor execution",
"transformation": {
"fields": ["_type", "totalApis", "generatedAt", "sourceUrl"]
},
"display": {
"component": "table",
"properties": {
"_type": {
"format": "text",
"label": "Type"
},
"totalApis": {
"format": "number",
"label": "Total APIs"
},
"sourceUrl": {
"format": "link",
"label": "Source URL"
},
"generatedAt": {
"format": "date",
"label": "Generated At"
}
}
}
}
}
}