Method buildMethod

packages/cli/src/swagger/specGenerator3.ts:258–331

(controllerName: string, method: Tsoa.Method, pathObject: any, defaultProduces?: string[])

  }

  protected buildMethod(controllerName: string, method: Tsoa.Method, pathObject: any, defaultProduces?: string[]) {
    const pathMethod: Swagger.Operation3 = (pathObject[method.method] = this.buildOperation(controllerName, method, defaultProduces));
    pathMethod.description = method.description;
    pathMethod.summary = method.summary;
    pathMethod.tags = method.tags;

    // Use operationId tag otherwise fallback to generated. Warning: This doesn't check uniqueness.
    pathMethod.operationId = method.operationId || pathMethod.operationId;

    if (method.deprecated) {
      pathMethod.deprecated = method.deprecated;
    }

    if (method.security) {
      pathMethod.security = method.security;
    }

    const bodyParams: Tsoa.Parameter[] = method.parameters.filter(p => p.in === 'body');
    const bodyPropParams: Tsoa.Parameter[] = method.parameters.filter(p => p.in === 'body-prop');
    const formParams: Tsoa.Parameter[] = method.parameters.filter(p => p.in === 'formData');
    const queriesParams: Tsoa.Parameter[] = method.parameters.filter(p => p.in === 'queries');

    pathMethod.parameters = method.parameters
      .filter(p => {
        return ['body', 'formData', 'request', 'body-prop', 'res', 'queries', 'request-prop'].indexOf(p.in) === -1;
      })
      .map(p => this.buildParameter(p));

    if (queriesParams.length > 1) {
      throw new Error('Only one queries parameter allowed per controller method.');
    }

    if (queriesParams.length === 1) {
      pathMethod.parameters.push(...this.buildQueriesParameter(queriesParams[0]));
    }

    if (bodyParams.length > 1) {
      throw new Error('Only one body parameter allowed per controller method.');
    }

    if (bodyParams.length > 0 && formParams.length > 0) {
      throw new Error('Either body parameter or form parameters allowed per controller method - not both.');
    }

    if (bodyPropParams.length > 0) {
      if (!bodyParams.length) {
        bodyParams.push({
          in: 'body',
          name: 'body',
          parameterName: 'body',
          required: true,
          type: {
            dataType: 'nestedObjectLiteral',
            properties: [],
          } as Tsoa.NestedObjectLiteralType,
          validators: {},
          deprecated: false,
        });