Nest js Swagger - Публикация различных документов API по отдельным маршрутам - PullRequest
Новая
       73

Nest js Swagger - Публикация различных документов API по отдельным маршрутам

0 голосов
/ 24 января 2020

Я создаю приложение с API c publi и внутренним. Я хотел бы опубликовать sh документы для этих различных маршрутов. Я думал, что это будет достигнуто путем добавления в документ только определенных тегов (addTag), но после дальнейшего чтения и экспериментов он не справится с работой.

Документы всегда содержат все, все задокументированные конечные точки из всех модулей.

Возможно ли это вообще? Если да, то как?

Я не верю, что код необходим, но FWIW: 

const pubOptions = new DocumentBuilder()
    .setTitle('Pub API Docs')
    .setDescription('Blah blah API documentation')
    .setVersion(p.version)
    .addBearerAuth()
    .addTag('public-app')
    .build();
const document = SwaggerModule.createDocument(app, pubOptions);
SwaggerModule.setup('public-api', app, document);

const internalOptions = new DocumentBuilder()
    .setTitle('Internal API Docs')
    .setDescription('Blah blah API documentation')
    .setVersion(p.version)
    .addBearerAuth()
    .addTag('internal')
    .build();
const iDocument = SwaggerModule.createDocument(app, internalOptions);
SwaggerModule.setup('internal-api', app, iDocument);

1 Ответ

1 голос
/ 24 января 2020

Вы должны указать функции SwaggerModule.createDocument, какие модули включить в состав swagger, который должен быть составлен. Вот соответствующие документы . В качестве третьего параметра вы можете передать объект со свойством include, которое содержит массив модулей. Эти модули относятся к документу чванства, который собирается быть построенным.

...