Можно ли добавить пользовательскую страницу в Swagger?

Question

Я создаю REST API с помощью NestJS и использую модуль 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.'
    );

Много полезной информации о модуле можно найти здесь , а отличный (хотя и базовый) пример можно увидеть на GitHub