tsoa-custom-decorators/tests/unit/swagger/schemaDetails.spec.ts

Build swagger-compliant REST APIs using TypeScript and Node

import 'mocha';
import { MetadataGenerator } from '../../../src/metadataGeneration/metadataGenerator';
import { SpecGenerator } from '../../../src/swagger/specGenerator';
import { getDefaultOptions } from '../../fixtures/defaultOptions';
import * as chai from 'chai';

const expect = chai.expect;

describe('Schema details generation', () => {
  const metadata = new MetadataGenerator('./tests/fixtures/controllers/getController.ts').Generate();
  const spec = new SpecGenerator(metadata, getDefaultOptions()).GetSpec();

  if (!spec.info) { throw new Error('No spec info.'); }
  if (!spec.info.title) { throw new Error('No spec info title.'); }
  if (!spec.info.description) { throw new Error('No spec info description.'); }
  if (!spec.info.version) { throw new Error('No spec info version.'); }
  if (!spec.host) { throw new Error('No host'); }

  it('should set API name if provided', () => expect(spec.info.title).to.equal(getDefaultOptions().name));
  it('should set API description if provided', () => expect(spec.info.description).to.equal(getDefaultOptions().description));
  it('should set API version if provided', () => expect(spec.info.version).to.equal(getDefaultOptions().version));
  it('should set API host if provided', () => expect(spec.host).to.equal(getDefaultOptions().host));

  const license = spec.info.license;
  if (!license) { throw new Error('No license.'); }

  const licenseName = license.name;
  if (!licenseName) { throw new Error('No license name.'); }

  it('should set API license if provided', () => expect(licenseName).to.equal(getDefaultOptions().license));
});