Prerequisites & Best Practices
-
Swagger/OpenAPI Documentation
Every Xano API group automatically provides a Swagger/OpenAPI specification.
Use this as your single source of truth for endpoints, headers, and request/response schemas. -
Personal Access Tokens (PATs)
Many platforms with a native Xano integration require a PAT (personal access token) for authentication. PATs are managed through the Metadata API in Xano, which is where you generate and maintain them. -
Platform Docs First
For frontend-specific instructions, always start with the platform’s own documentation. Links to key platform docs are included in each section below.
WeWeb + Xano
WeWeb provides dedicated plugins for connecting to Xano.Data Source Plugin
- In WeWeb, navigate to Plugins → Data Sources → Xano.
- Add your Xano connection and supply your Personal Access Token (from the Metadata API).
- Create Collections to fetch data and optionally set global headers at the plugin or collection level.
- If you also use the Auth plugin, tokens are forwarded automatically.
Auth Plugin
Use the WeWeb Xano Auth Plugin to handle signup/login flows, gated content, and role-based redirects.Bubble + Xano
Bubble can integrate with Xano in two primary ways:Xano Connector Plugin
Community-driven plugin built around the official JS SDK. It simplifies authentication and supports real-time features.Bubble Xano Connector Guide
Bubble API Connector
Use Bubble’s native API Connector to configure endpoints manually. Copy endpoint URLs, headers, and payloads directly from your Swagger docs. Bubble API Connector GuideAI Builders (e.g. Lovable)
AI app builders like Lovable can ingest your OpenAPI specification to generate an entire frontend with connected API calls.- In Xano, open your API group and click Swagger (OpenAPI Documentation).
- Copy the OpenAPI/JSON link.
- In Lovable (or a similar AI builder), import the spec to auto-generate endpoints, forms, and API actions.
- Lovable AI Builder (see their docs for details)
- Xano’s Swagger/OpenAPI Documentation
Using Swagger with IDE Copilots
Provide the OpenAPI file to your IDE’s AI assistant (e.g. Cursor, GitHub Copilot Chat) to generate accurate code and types.- In Xano, open your API group and click Swagger (OpenAPI Documentation).
- Copy the OpenAPI/JSON link.
- In your IDE of choice, either provide the link to the OpenAPI spec for your API groups, or download them and store them as a part of your project.
Traditional Development (TypeScript / JavaScript)
You can connect to Xano with plainfetch
/axios
or use the offical JS SDK.
Fetch Example
JS SDK
The Xano JS SDK provides helpers for authentication and API calls and powers several third-party plugins.Environment & Troubleshooting Tips
- Branching: Use branches for backend logic changes, but keep schemas consistent across branches to avoid frontend mismatches. Read more about Branching & Merging.
- Data Sources: In WeWeb, you can set different data sources for editor, staging, and production environments. Read more about WeWeb Xano Data Source.
- Platform Docs: For details like real-time features, caching, or auth strategies, always refer to the frontend platform’s official documentation.
Quick Links
- Xano Swagger/OpenAPI Docs
- WeWeb Xano Data Source
- WeWeb Xano Auth
- Bubble Xano Connector
- Xano JS SDK (GitLab)
- Lovable AI Builder
💡 Reminder: For frontend-specific configuration (authentication flows, deployment steps, plugin settings, etc.), the best source of truth is the documentation provided by the frontend platform itself.