route

Generate Server Route

Create a server-side route for your Kibana plugin. Ask the user for:

1. HTTP method: GET, POST, PUT, DELETE, PATCH
2. Route path: e.g., /api/my_plugin/items or /api/my_plugin/items/{id}
3. What it does: Brief description
4. Request parameters:
   • Path params (from URL, e.g., {id})
   • Query params (e.g., ?page=1&perPage=20)
   • Body (for POST/PUT/PATCH)
5. Response: What it returns
6. Needs authentication? (default: yes)
7. Data source: Elasticsearch, Saved Objects, or external API

Route Template

import { schema } from '@kbn/config-schema';
import type { IRouter } from '@kbn/core/server';

export function register{RouteName}Route(router: IRouter) {
  router.{method}(
    {
      path: '{route_path}',
      options: {
        tags: ['access:{plugin_id}'],
      },
      validate: {
        params: schema.object({
          // Path parameters
          id: schema.string(),
        }),
        query: schema.object({
          // Query parameters
          page: schema.number({ defaultValue: 1, min: 1 }),
          perPage: schema.number({ defaultValue: 20, min: 1, max: 100 }),
          search: schema.maybe(schema.string()),
        }),
        body: schema.object({
          // Body parameters (POST/PUT/PATCH)
          name: schema.string({ minLength: 1, maxLength: 255 }),
          enabled: schema.boolean({ defaultValue: true }),
        }),
      },
    },
    async (context, request, response) => {
      try {
        const coreContext = await context.core;
        const { id } = request.params;
        const { page, perPage, search } = request.query;
        const { name, enabled } = request.body;

        // Implementation here

        return response.ok({
          body: {
            // Response data
          },
        });
      } catch (error) {
        // Error handling
        if (error.output?.statusCode === 404) {
          return response.notFound({
            body: { message: error.message },
          });
        }
        return response.customError({
          statusCode: error.output?.statusCode || 500,
          body: { message: error.message },
        });
      }
    }
  );
}