bknd-api-discovery_skill

This skill helps you discover and map Bknd's auto-generated REST endpoints, routes, and SDK methods for faster integration.

2

GitHub Stars

1

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill cameronapak/bknd-skills --skill bknd-api-discovery

SKILL.md12.9 KB

Overview

This skill helps you explore and understand Bknd's auto-generated REST API endpoints so you can integrate, document, or debug services quickly. It summarizes common base paths, CRUD patterns, SDK mappings, and provides practical commands and examples to discover available entities and routes.

How this skill works

Inspect routes with the built-in debug command to list registered endpoints and map them to SDK methods. Use the admin panel in UI mode to browse entities, fields, and sample data visually. In code mode, call the Api/ App objects to probe endpoints programmatically and run quick health checks or discovery scripts.

When to use it

When you need a quick inventory of available API routes and modules
When integrating frontend or third-party services and you need endpoint patterns
When documenting or building SDK wrappers for Bknd APIs
When troubleshooting 404s, auth path issues, or unexpected responses
When exploring entity schemas and relations before writing queries

Best practices

Always use the /api/ prefix and exact entity names (case-sensitive) in paths
Run bknd debug routes to get an authoritative list of registered endpoints
Use POST /api/data/:entity/query for complex filters and nested operators
Include Content-Type: application/json for POST and PATCH requests
Verify auth strategy in the login path (e.g., /api/auth/password/login)

Example use cases

List all registered routes: bknd debug routes and review GET/POST/PATCH/DELETE patterns
Discover whether a common entity exists by attempting api.data.readMany(entity, { limit: 1 })
Test auth endpoints by calling GET /api/auth/me and POST /api/auth/password/login
Upload and serve media using POST /api/media/upload and GET /api/media/:path
Run a discovery script to produce a report of working endpoints and entity counts

FAQ

Use bknd debug routes in the CLI or build the App instance and inspect the server's Hono routes after app.build().

When should I use GET vs POST for data queries?

Use GET for simple filters and pagination. Use POST /api/data/:entity/query for complex conditions, nested operators, or large payloads.