@loopback/openapi-v3/src/decorators/api.decorator.ts

Decorators that annotate LoopBack artifacts with OpenAPI v3 metadata and utilities that transform LoopBack metadata to OpenAPI v3 specifications

// Copyright IBM Corp. and LoopBack contributors 2018,2020. All Rights Reserved.
// Node module: @loopback/openapi-v3
// This file is licensed under the MIT License.
// License text available at https://opensource.org/licenses/MIT

import {ClassDecoratorFactory} from '@loopback/core';
import {ControllerSpec} from '../controller-spec';
import {OAI3Keys} from '../keys';

/**
 * Decorate the given Controller constructor with metadata describing
 * the HTTP/REST API the Controller implements/provides.
 *
 * `@api` can be applied to controller classes.
 *
 * @example
 *
 * ```ts
 * @api({basePath: '/my'})
 * class MyController {
 *   // ...
 * }
 * ```
 *
 * @param spec - OpenAPI specification describing the endpoints
 * handled by this controller
 *
 */
export function api(spec: Partial<ControllerSpec>) {
  const controllerSpec: ControllerSpec = {paths: {}, ...spec};
  return ClassDecoratorFactory.createDecorator<ControllerSpec>(
    OAI3Keys.CLASS_KEY,
    controllerSpec,
    {decoratorName: '@api'},
  );
}