千鋒教育-做有情懷、有良心、有品質(zhì)的職業(yè)教育機(jī)構(gòu)

手機(jī)站
千鋒教育

千鋒學(xué)習(xí)站 | 隨時(shí)隨地免費(fèi)學(xué)

千鋒教育

掃一掃進(jìn)入千鋒手機(jī)站

領(lǐng)取全套視頻
千鋒教育

關(guān)注千鋒學(xué)習(xí)站小程序
隨時(shí)隨地免費(fèi)學(xué)習(xí)課程

當(dāng)前位置:首頁(yè)  >  技術(shù)干貨  > 如何關(guān)閉Swagger

如何關(guān)閉Swagger

來(lái)源:千鋒教育
發(fā)布人:xqq
時(shí)間: 2023-11-20 18:49:49 1700477389

Swagger是一種API文檔工具,可以生成API文檔、可視化前端測(cè)試等。然而,有些情況下,我們可能不需要使用Swagger,本文將介紹如何關(guān)閉Swagger。

一、在Spring Boot項(xiàng)目中關(guān)閉Swagger

如果您正在使用Spring Boot構(gòu)建API,那么Swagger通常是通過(guò)Swagger UI實(shí)現(xiàn)的。關(guān)閉Swagger UI的方法是非常簡(jiǎn)單的,只需添加以下配置即可:


    io.springfox
    springfox-swagger-ui
    2.9.2
    provided

事實(shí)上,這是從項(xiàng)目中刪除Swagger依賴項(xiàng),以使其不可用。如果您想要稍后重新啟用Swagger,只需將其添加回來(lái)即可。

二、在Node.js中關(guān)閉Swagger

Node.js中的Swagger通常是通過(guò)swagger-ui-express包實(shí)現(xiàn)的。關(guān)閉Swagger UI的方法是非常簡(jiǎn)單的,只需將以下代碼從項(xiàng)目中刪除即可:

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

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

這將從您的項(xiàng)目中刪除Swagger UI中間件和Swagger文檔。如果您想要重新啟用Swagger UI,只需將它們添加回來(lái)即可。

三、在Django項(xiàng)目中關(guān)閉Swagger

Django REST framework中的Swagger通常是通過(guò)django-rest-swagger包實(shí)現(xiàn)的。關(guān)閉Swagger UI的方法是非常簡(jiǎn)單的,只需將以下代碼從項(xiàng)目中刪除即可:

from rest_framework_swagger.views import get_swagger_view

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

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

這將從您的Django項(xiàng)目中刪除Swagger UI,并阻止其通過(guò)URL路由到/路徑。如果您想要重新啟用Swagger UI,只需將它們添加回來(lái)即可。

四、在Laravel項(xiàng)目中關(guān)閉Swagger

Laravel項(xiàng)目中的Swagger通常是通過(guò)Dingo API和Swagger PHP包實(shí)現(xiàn)的。關(guān)閉Swagger UI的方法是非常簡(jiǎn)單的,只需將以下代碼從項(xiàng)目中刪除即可:

$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項(xiàng)目中刪除Swagger UI,并阻止其通過(guò)URL路由到/docs路徑。如果您想要重新啟用Swagger UI,請(qǐng)將它們添加回來(lái)。

聲明:本站稿件版權(quán)均屬千鋒教育所有,未經(jīng)許可不得擅自轉(zhuǎn)載。
10年以上業(yè)內(nèi)強(qiáng)師集結(jié),手把手帶你蛻變精英
請(qǐng)您保持通訊暢通,專屬學(xué)習(xí)老師24小時(shí)內(nèi)將與您1V1溝通
免費(fèi)領(lǐng)取
今日已有369人領(lǐng)取成功
劉同學(xué) 138****2860 剛剛成功領(lǐng)取
王同學(xué) 131****2015 剛剛成功領(lǐng)取
張同學(xué) 133****4652 剛剛成功領(lǐng)取
李同學(xué) 135****8607 剛剛成功領(lǐng)取
楊同學(xué) 132****5667 剛剛成功領(lǐng)取
岳同學(xué) 134****6652 剛剛成功領(lǐng)取
梁同學(xué) 157****2950 剛剛成功領(lǐng)取
劉同學(xué) 189****1015 剛剛成功領(lǐng)取
張同學(xué) 155****4678 剛剛成功領(lǐng)取
鄒同學(xué) 139****2907 剛剛成功領(lǐng)取
董同學(xué) 138****2867 剛剛成功領(lǐng)取
周同學(xué) 136****3602 剛剛成功領(lǐng)取
相關(guān)推薦HOT
詳解pd.cut函數(shù)

一、pd.cut用法pd.cut()是一個(gè)用于將連續(xù)變量轉(zhuǎn)換成離散變量的函數(shù),通俗地說(shuō)就是將一組數(shù)據(jù)按照一定的規(guī)則自動(dòng)分成幾段,然后用這幾段來(lái)表示原...詳情>>

2023-11-20 21:31:50
如何完全卸載wine

一、卸載wine安裝的軟件在卸載wine之前,首先需要卸載通過(guò)wine安裝的軟件,否則這些軟件可能會(huì)影響到wine的卸載過(guò)程。卸載軟件的方法與在Window...詳情>>

2023-11-20 21:24:38
Qt時(shí)間戳轉(zhuǎn)換日期格式

一、概述Qt是一個(gè)跨平臺(tái)的GUI開(kāi)發(fā)框架,它提供了一套豐富的API,可以用C++進(jìn)行編程。在Qt中,時(shí)間戳是指一個(gè)整數(shù),代表從某個(gè)固定時(shí)間點(diǎn)經(jīng)過(guò)了...詳情>>

2023-11-20 20:59:26
p7zip的介紹與應(yīng)用

p7zip是一個(gè)基于7zip算法的文件歸檔壓縮軟件。它可以在Windows、Linux、macOS等多種操作系統(tǒng)上運(yùn)行。p7zip可以處理眾多格式的文件,包括7z、zip...詳情>>

2023-11-20 20:37:50
如何卸載eclipse

在使用eclipse過(guò)程中,有時(shí)候我們需要將其卸載。下面將從多個(gè)方面來(lái)介紹如何卸載eclipse。一、卸載eclipse的常規(guī)方法1、關(guān)閉所有eclipse應(yīng)用程...詳情>>

2023-11-20 20:19:50