Skip to main content

Deploy API

  • Once your project is configured (schema synced, authentication set up, user mapping, social auth, and authorization), navigate to the Deploy API step to generate and publish your REST API.
  • Click Deploy API to build and expose REST endpoints for all tables and relationships defined in your synced schema; SWAIN automatically generates CRUD endpoints and OpenAPI documentation.
  • The API will be hosted in the SWAIN environment associated with your project; use JWT tokens or API keys to authenticate requests and secure access.
  • Use the interactive API explorer in the SWAIN dashboard to test your endpoints, view request/response formats, and ensure your configuration works as expected.
  • If you need client SDKs, use the Swain CLI or the SDK Generation feature to generate SDKs in your preferred languages after deployment.
  • Whenever you update your schema or configuration, redeploy the API to apply changes; SWAIN will regenerate endpoints and documentation automatically.
Back to top