Function buildMethodSpec

packages/cli/generators/openapi/spec-helper.js:208–435

* Build method spec for an operation * @param {object} OpenAPI operation

(controllerSpec, op, options)

 * @param {object} OpenAPI operation
 */
function buildMethodSpec(controllerSpec, op, options) {
  const methodName = getMethodName(op.spec);
  const opName = op.spec['x-operation-name'] || op.spec['operationId'];
  controllerSpec.methodMapping[methodName] = opName;
  const comments = [];
  let args = [];
  let interfaceArgs = [];
  const namedParameters = [];
  const parameters = op.spec.parameters;
  // Keep track of param names to avoid duplicates
  const paramNames = {};
  const interfaceParamNames = {};
  if (parameters) {
    args = parameters.map(p => {
      const {paramType, argName} = buildParameter(p, paramNames, comments);
      const paramJson = printSpecObject(p);
      const optionalType = !p.required ? ' | undefined' : '';
      return `@param(${paramJson}) ${argName}: ${paramType.signature}${optionalType}`;
    });
    interfaceArgs = parameters.map(p => {
      const param = buildParameter(p, interfaceParamNames);
      namedParameters.push(param);
      const {paramType, argName} = param;
      const optionalType = !p.required ? ' | undefined' : '';
      return `${argName}: ${paramType.signature}${optionalType}`;
    });
  }
  if (op.spec.requestBody) {
    /**
     * requestBody:
     *  description: Pet to add to the store
     *  required: true
     *  content:
     *    application/json:
     *      schema:
     *        $ref: '#/components/schemas/NewPet'
     */
    let bodyType = {signature: 'unknown'};
    const content = op.spec.requestBody.content;
    const contentType =
      content &&
      (content['application/json'] || content[Object.keys(content)[0]]);

    let bodyName = 'requestBody';
    if (bodyName in paramNames) {
      bodyName = `${bodyName}${paramNames[bodyName]++}`;
    }
    bodyName = escapeIdentifier(bodyName);
    if (contentType && contentType.schema) {
      registerAnonymousSchema(
        [methodName, bodyName],
        contentType.schema,
        options,
      );
      bodyType = mapSchemaType(contentType.schema, options);
      addImportsForType(bodyType);
    }
    const bodyParam = bodyName; // + (op.spec.requestBody.required ? '' : '?');