如何关闭Swagger

Swagger是一种API文档工具，可以生成API文档、可视化前端测试等。然而，有些情况下，我们可能不需要使用Swagger，本文将介绍如何关闭Swagger。

一、在Spring Boot项目中关闭Swagger

如果您正在使用Spring Boot构建API，那么Swagger通常是通过Swagger UI实现的。关闭Swagger UI的方法是非常简单的，只需添加以下配置即可：

 io.springfox
    springfox-swagger-ui
    2.9.2
    provided 

事实上，这是从项目中删除Swagger依赖项，以使其不可用。如果您想要稍后重新启用Swagger，只需将其添加回来即可。

二、在Node.js中关闭Swagger

Node.js中的Swagger通常是通过swagger-ui-express包实现的。关闭Swagger UI的方法是非常简单的，只需将以下代码从项目中删除即可：

const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.json');

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

这将从您的项目中删除Swagger UI中间件和Swagger文档。如果您想要重新启用Swagger UI，只需将它们添加回来即可。

三、在Django项目中关闭Swagger

Django REST framework中的Swagger通常是通过django-rest-swagger包实现的。关闭Swagger UI的方法是非常简单的，只需将以下代码从项目中删除即可：

from rest_framework_swagger.views import get_swagger_view

schema_view = get_swagger_view(title='API文档')

urlpatterns = [
    url(r'^', schema_view),
]

这将从您的Django项目中删除Swagger UI，并阻止其通过URL路由到/路径。如果您想要重新启用Swagger UI，只需将它们添加回来即可。

四、在Laravel项目中关闭Swagger

Laravel项目中的Swagger通常是通过Dingo API和Swagger PHP包实现的。关闭Swagger UI的方法是非常简单的，只需将以下代码从项目中删除即可：

$api = app('Dingo\Api\Routing\Router');

$api->version('v1', function ($api) {
    $api->get('/docs', ['as' => 'docs.index', 'uses' => 'App\Http\Controllers\Api\DocsController@index']);
});

这将从您的Laravel项目中删除Swagger UI，并阻止其通过URL路由到/docs路径。如果您想要重新启用Swagger UI，请将它们添加回来。

鹏仔微信 15129739599 鹏仔QQ344225443 鹏仔前端 pjxi.com 共享博客 sharedbk.com