Question

我正在使用NestJS构建REST API，并使用Swagger模块生成文档。

Swagger创建了有关我所有路线的一页文档。我想在现有文档的顶部手动添加一些文档。有什么办法可以做到吗？

Answer 1

如果您使用@ nestjs / swagger模块，则可以在setDescription()对象（由SwaggerBaseConfig创建）上使用new DocumentBuilder()方法添加支持降价的描述。您可能会看到类似

的内容

  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.'
    );

有关模块can be found here的很多重要信息，以及一个很好的（虽然很基本的）示例can be seen on GitHub

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

1 个答案: