@readme/oas-examples/test/index.test.ts

A collection of example OpenAPI 3.x and Swagger 2.0 documents.

import path from 'node:path';

import { parse } from '@readme/openapi-parser';
import fg from 'fast-glob';
import toBeAValidOpenAPIDefinition from 'jest-expect-openapi';
import { describe, expect, it } from 'vitest';

expect.extend({ toBeAValidOpenAPIDefinition });

describe.each([
  ['Swagger 2.0', 'swagger', '2.0'],
  ['OpenAPI 3.0', 'openapi', '3.0'],
  ['OpenAPI 3.1', 'openapi', '3.1'],
])('%s', (_, specification, version) => {
  it('should have parity between JSON and YAML petstores', async () => {
    const json = await parse(path.join(import.meta.dirname, `../${version}/json/petstore.json`));
    const yaml = await parse(path.join(import.meta.dirname, `../${version}/yaml/petstore.yaml`));

    expect(json).toStrictEqual(yaml);
  });

  describe('JSON', () => {
    it.each(
      fg.sync([path.join(import.meta.dirname, `../${version}/json/*.json`)]).map(file => [path.basename(file), file]),
    )('should validate `%s` as valid', async (__, file) => {
      await expect(file).toBeAValidOpenAPIDefinition();
      await expect(parse(file)).resolves.toStrictEqual(
        expect.objectContaining({
          [specification]: expect.stringContaining(version),
        }),
      );
    });
  });

  describe('YAML', () => {
    it.each(
      fg.sync([path.join(import.meta.dirname, `../${version}/yaml/*.yaml`)]).map(file => [path.basename(file), file]),
    )('should validate `%s` as valid', async (__, file) => {
      await expect(file).toBeAValidOpenAPIDefinition();
      await expect(parse(file)).resolves.toStrictEqual(
        expect.objectContaining({
          [specification]: expect.stringContaining(version),
        }),
      );
    });
  });
});