toolhive-studio: Skill for Claude Code

Testing API Assertions

Verify that your code sends the correct API requests for operations with side effects.

When to Use Request Assertions

DO use for operations with side effects:

• Creating resources (POST)
• Updating resources (PUT/PATCH)
• Deleting resources (DELETE)
• Any mutation that changes backend state

DON'T use for read operations:

• Fetching data (GET)
• For these, just verify the component displays the data correctly
• The mock API is not stateful, so verifying GET requests adds no value

recordRequests()

Use recordRequests() to capture all API requests made during a test:

import { recordRequests } from '@/common/mocks/node'

it('creates a group with correct payload', async () => {
  const rec = recordRequests()

  // ... perform action that triggers API call ...
  await userEvent.click(screen.getByRole('button', { name: /create/i }))

  // Find the request
  const request = rec.recordedRequests.find(
    (r) => r.method === 'POST' && r.pathname === '/api/v1beta/groups'
  )

  // Assert it was made with correct data
  expect(request).toBeDefined()
  expect(request?.payload).toEqual({ name: 'my-group' })
})

Recorded Request Shape

Each recorded request contains:

{
  pathname: '/api/v1beta/groups',      // URL path
  method: 'POST',                       // HTTP method
  payload: { name: 'my-group' },        // Parsed JSON body (if present)
  search: { filter: 'active' },         // Query parameters
}

Common Patterns

Verify POST payload

const rec = recordRequests()

// ... trigger create action ...

const createRequest = rec.recordedRequests.find(
  (r) => r.method === 'POST' && r.pathname === '/api/v1beta/workloads'
)
expect(createRequest?.payload).toMatchObject({
  name: 'my-server',
  group: 'default',
})

Verify DELETE was called

const rec = recordRequests()

// ... trigger delete action ...

const deleteRequest = rec.recordedRequests.find(
  (r) =>
    r.method === 'DELETE' && r.pathname === '/api/v1beta/workloads/my-server'
)
expect(deleteRequest).toBeDefined()