Documentation

1. Creating Your First Project

Start by creating a new project from the dashboard:

• Navigate to the Dashboard
• Click the "Create Project" button
• Enter a project name and optional description
• Your new project will appear in the sidebar under "Projects"

2. Setting Up Your Database

Create a new database instance within your project:

• Expand your project in the sidebar
• Click on "Databases"
• Click "Create Database"
• Enter a name for your database
• Your new database will appear in the sidebar under your project

3. Creating Tables

Define your data structure by creating tables:

• Click on your database in the sidebar
• Click "Create Table"
• Define your table schema by adding fields
• For each field, specify the name and data type
• Your tables will appear in the sidebar under your database

4. Accessing Your API

View and test your auto-generated API:

• Navigate to your database page
• Click "View OpenAPI" to open the API documentation
• Test your endpoints directly in the OpenAPI viewer
• Click "Download JSON" to get the OpenAPI specification file

5. Managing API Keys

Create and manage API keys for authentication:

• Click "API Keys" in your project's sidebar section
• Click "Generate New Key"
• Save your API key securely - it won't be shown again
• Use this key in the Authorization header of your API requests

6. Generating API Clients

After downloading your OpenAPI specification, you can generate client libraries:

• OpenAPI Generator (Official): GitHub Repository
• Swagger Codegen: GitHub Repository
• NSwag: GitHub Repository

7. Using the API

Start making requests to your API with the generated client libraries. Don't forget about the API key! It needs to be in the header of every request. Check the OpenAPI viewer for examples.