NestJs Swagger如何添加自定义图标

debugcn 发表于 Dev

法里德·哈纳尔（Farid Hajnal）

我正在尝试向我的NestJs文档添加自定义图标。但是，我对路径文件的解析方式有点迷茫，不确定如何实现。

我正在使用nestjs / swagger模块版本3.1.0，并尝试在初始化Swagger模块时像这样传递路径文件。

我的main.ts文件

SwaggerModule.setup('/v1/docs', app, document, {
    customCss: CUSTOM_STYLE,
    customSiteTitle: 'My API Documentation',
    customfavIcon: './public/favicon.jpg'
});

搜索了github问题，没有发现任何有用的信息。从代码中可以看到，我能够修改CSS样式，但是我无法弄清楚如何创建favicon自定义。

感谢任何帮助

pravindot17

我使用以下命令将自定义图标添加到我的swagger文档中：

您要确保的第一件事是，在您main.ts的应用程序中使用以下代码初始化：

const app: NestExpressApplication = await NestFactory.create(...)

要提供静态内容，您必须使用初始化您的应用NestExpressApplication。

下一步是允许Nest应用程序main.ts在初始化后使用以下内容查找公共内容：

app.useStaticAssets(join(__dirname, '..', 'public'));

另外，在应用程序的根目录中创建一个公共目录，然后将favicon.jpg文件粘贴到该目录中。

现在是时候初始化Swagger了 main.ts

SwaggerModule.setup('/v1/docs', app, document, {
    customCss: CUSTOM_STYLE,
    customSiteTitle: 'My API Documentation',
    customfavIcon: '../favicon.jpg'
});

您必须提供到应用程序根目录的相对路径，例如../favicon.jpg万一我们main.ts位于src应用程序根目录中的文件夹中。

本文收集自互联网，转载请注明来源。

如有侵权，请联系[email protected] 删除。