Laravel mpociot/Laravel-apidoc-generator 设置修改 logo

淡淡的烟草味﹌ 2022-11-06 11:48 46阅读 0赞

我们在 laravel 中使用 mpociot/Laravel-apidoc-generator 生成 api文档的时候，会有这么一个展示页面

在页面的左上角有个logo，默认是这个样子的，那么如何修改这个logo呢，换成我们自己的logo；

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N2cGVy_size_16_color_FFFFFF_t_70][]

配置方法：

在项目目录中找到 apidoc.php 这个文件就是用来配置相关信息的；

我这里测试用的 laravel 6 版本项目，位置在： /config/apidoc.php

如果不在这里的话，可以在项目目录中全局搜索一下 apidoc.php 这个文件

打开这个文件，我们找到下面的代码：

/*
         * Custom logo path. The logo will be copied from this location
         * during the generate process. Set this to false to use the default logo.
         *
         * Change to an absolute path to use your custom logo. For example:
         * 'logo' => resource_path('views') . '/api/logo.png'
         *
         * If you want to use this, please be aware of the following rules:
         * - the image size must be 230 x 52
         */
        'logo' => false,

这就是默认的设置和一些说明信息，

我们修改如下即可：

'logo' => resource_path('docs') . '/images/logo2.png',

我们换了一张 logo2.png 图片替换了原来的图片；

我把这张 logo2.png 图片放在了 /resources/docs/images/logo2.png

因为你会发现 docs 目录就在 resources 目录下

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N2cGVy_size_16_color_FFFFFF_t_70 1][]

这个 docs目录就是我们的文档 api 文件；

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N2cGVy_size_16_color_FFFFFF_t_70 2][]

最后我们生成 api文档的时候，/public 目录下也会增加这个可访问的 api 文档文件；

我们设置完成保存文件后，重新生成 api 文档，logo就会替换掉了，我这里的logo图片是截取了windows操作系统的计算机管理界面的一小块，不要介意

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N2cGVy_size_16_color_FFFFFF_t_70 3][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N2cGVy_size_16_color_FFFFFF_t_70]: /images/20221023/7e7a0b9c82e643c9bbda6bcba9edb965.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N2cGVy_size_16_color_FFFFFF_t_70 1]: /images/20221023/d864c6d1f14c403a907a3078978a9e0a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N2cGVy_size_16_color_FFFFFF_t_70 2]: /images/20221023/b1fa191ea6b0463ca80b8c403ee60317.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N2cGVy_size_16_color_FFFFFF_t_70 3]: /images/20221023/aa8baec328ba462da460b0ac6921e921.png