Method serveDefinitions

lib/swagger-module.ts:298–357

(
    httpAdapter: HttpServer,
    getBuiltDocument: () => OpenAPIObject,
    options: {
      jsonDocumentUrl: string;
      yamlDocumentUrl: string;
      swaggerOptions: SwaggerCustomOptions;
    },
    serveOptions: { serveJson: boolean; serveYaml: boolean }
  )

  }

  protected static serveDefinitions(
    httpAdapter: HttpServer,
    getBuiltDocument: () => OpenAPIObject,
    options: {
      jsonDocumentUrl: string;
      yamlDocumentUrl: string;
      swaggerOptions: SwaggerCustomOptions;
    },
    serveOptions: { serveJson: boolean; serveYaml: boolean }
  ) {
    if (serveOptions.serveJson) {
      httpAdapter.get(
        normalizeRelPath(options.jsonDocumentUrl),
        async (req, res) => {
          res.type('application/json');
          const document = getBuiltDocument();

          const documentToSerialize = options.swaggerOptions
            .patchDocumentOnRequest
            ? await Promise.resolve(
                options.swaggerOptions.patchDocumentOnRequest(
                  req,
                  res,
                  document
                )
              )
            : document;

          return res.send(JSON.stringify(documentToSerialize));
        }
      );
    }

    if (serveOptions.serveYaml) {
      httpAdapter.get(
        normalizeRelPath(options.yamlDocumentUrl),
        async (req, res) => {
          res.type('text/yaml');
          const document = getBuiltDocument();

          const documentToSerialize = options.swaggerOptions
            .patchDocumentOnRequest
            ? await Promise.resolve(
                options.swaggerOptions.patchDocumentOnRequest(
                  req,
                  res,
                  document
                )
              )
            : document;

          const yamlDocument = jsyaml.dump(documentToSerialize, {
            skipInvalid: true,
            noRefs: true
          });
          return res.send(yamlDocument);
        }
      );