API Compatibility Guide
n8endpoint is designed to work with a wide variety of API documentation formats. Here's what you need to know about compatibility.
Fully Supported Formats
OpenAPI/Swagger
- ✅ Swagger UI interfaces
- ✅ OpenAPI 3.0 specifications
- ✅ Redoc documentation
- ✅ Auto-generated API docs
REST API Documentation
- ✅ Standard REST endpoint listings
- ✅ HTTP method specifications (GET, POST, PUT, DELETE)
- ✅ URL parameter documentation
- ✅ Request/response examples
Partially Supported
Custom Documentation Sites
- ⚠️ May require manual selection
- ⚠️ Success depends on HTML structure
- ⚠️ Some endpoints might not be detected
GraphQL APIs
- ⚠️ Limited support for REST-like queries
- ⚠️ Schema introspection not supported
Not Supported
- ❌ SOAP APIs
- ❌ WebSocket documentation
- ❌ gRPC specifications
- ❌ PDF documentation files
Testing Your Documentation
To test if your API documentation works with n8endpoint:
- Install the extension
- Navigate to your API docs
- Click the extension icon
- Look for highlighted endpoints
If endpoints aren't detected, try:
- Scrolling through the entire page
- Expanding collapsed sections
- Checking for dynamic content loading
Popular Compatible Sites
n8endpoint works well with documentation from:
- Stripe API
- GitHub API
- Twitter API
- Shopify API
- Many others following standard formats
Reporting Compatibility Issues
Found a site that should work but doesn't? Let us know at info@n8endpoint.dev with:
- The documentation URL
- What you expected to happen
- What actually happened
- Screenshots if helpful