JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 12
  • Score
    100M100P100Q84916F
  • License Apache-2.0

SDK for building Mimic API mock adapters — base class, test helpers, and shared utilities

Package Exports

  • @mimicai/adapter-sdk

Readme

@mimicai/adapter-sdk

SDK for building custom Mimic API mock adapters — base class, test helpers, and shared utilities.

Install

npm install @mimicai/adapter-sdk

Usage

Create a new adapter by extending BaseApiMockAdapter:

import { BaseApiMockAdapter } from '@mimicai/adapter-sdk';

export class MyServiceAdapter extends BaseApiMockAdapter {
  name = 'my-service';

  buildRoutes() {
    return [
      {
        method: 'GET',
        path: '/api/items',
        handler: (req) => this.handleListItems(req),
      },
    ];
  }
}

Test helpers

The SDK includes test utilities for verifying your adapter:

import { createTestAdapter } from '@mimicai/adapter-sdk';

const adapter = createTestAdapter(MyServiceAdapter);
const response = await adapter.request('GET', '/api/items');

See also

License

Apache 2.0