是否可以在Swagger中添加自定义页面?

是否可以在Swagger中添加自定义页面?,swagger,nestjs,openapi,Swagger,Nestjs,Openapi,我正在用NestJS构建一个RESTAPI,并使用Swagger模块生成一个文档 斯威格创建了一个关于我所有路线的单页文档。我想在现有文档的基础上手动添加一些文档。有什么方法可以做到这一点吗?如果您使用@nestjs/swagger模块,您可以在SwaggerBaseConfig对象(使用new DocumentBuilder()创建)上添加一个说明,该说明支持使用setDescription()方法进行标记。您可能会有如下内容 const document = new DocumentBu

我正在用NestJS构建一个RESTAPI,并使用Swagger模块生成一个文档


斯威格创建了一个关于我所有路线的单页文档。我想在现有文档的基础上手动添加一些文档。有什么方法可以做到这一点吗?

如果您使用@nestjs/swagger模块,您可以在
SwaggerBaseConfig
对象(使用
new DocumentBuilder()
创建)上添加一个说明,该说明支持使用
setDescription()
方法进行标记。您可能会有如下内容

  const document = new DocumentBuilder()
    .setTitle('My Api')
    .addTag('My Tag', 'The description for it')
    .setBasePath('/api')
    .setDescription('Here is where you can add extra documentation that will' +
        ' show up above the generated swagger file. You can make it as long' +
        ' or as short as you would like. You technically don\'t need to wrap' +
        ' the string either, it just makes things easier to read.'
    );
关于该模块的大量信息和一个很好的(虽然是基本的)示例