Express中使用Swagger的實(shí)現(xiàn)示例
Swagger
Swagger 是一種規(guī)范，用于描述 API 的結(jié)構(gòu)，功能和參數(shù)。使用 Swagger 可以提供清晰的可視化 API 文檔，可用于 API 交互的文檔驅(qū)動(dòng)開發(fā)，以及 API 的自動(dòng)化測(cè)試和集成。
- 使用 npm 或 yarn 下載。
npm install swagger-jsdoc swagger-ui-express --save
yarn add swagger-jsdoc swagger-ui-express
- 在 Express 根目錄下的
app.js中導(dǎo)入。
const swaggerJsdoc = require('swagger-jsdoc');
const swaggerUi = require('swagger-ui-express');
// ...
// definition 字段用于定義 Swagger 規(guī)范，apis 字段用于指定使用 Swagger 規(guī)范的 API 文件路徑
const options = {
definition: {
openapi: '3.0.0',
info: {
title: 'My API',
version: '1.0.0'
}
},
apis: ['./routes/*.js']
};
const swaggerSpec = swaggerJsdoc(options);
app.use('/api', swaggerUi.serve, swaggerUi.setup(swaggerSpec));
// 其他路由...
- 導(dǎo)入后即可在 router 中新增 Swagger 注釋。
/** * @swagger * /users: * get: * summary: 獲取所有用戶信息 * responses: * 200: * description: 成功獲取所有用戶信息 * * post: * summary: 創(chuàng)建用戶 * parameters: * - in: body * name: user * schema: * type: object * properties: * name: * type: string * age: * type: integer * responses: * 200: * description: 成功創(chuàng)建用戶 */
如果編寫接口時(shí)使用的是 ApiFox 或 PostCat 等支持導(dǎo)出 OpenAI 規(guī)范文件的接口工具，
可以導(dǎo)出 OpenAI 規(guī)范的接口文件，然后訪問(wèn) Swagger Editor 并導(dǎo)入接口文件。將左側(cè)顯示的內(nèi)容復(fù)制到 Express 的路由文件中，并調(diào)整格式如上文所示注釋格式即可。
跳轉(zhuǎn) Express 下的
/api即可訪問(wèn)所有使用 Swagger 規(guī)范的 API 接口。
到此這篇關(guān)于Express中使用Swagger的實(shí)現(xiàn)示例的文章就介紹到這了,更多相關(guān)Express使用Swagger內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Nodejs讀取本地json文件,輸出json數(shù)據(jù)接口方式
這篇文章主要介紹了Nodejs讀取本地json文件,輸出json數(shù)據(jù)接口方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-10-10
這篇文章主要介紹了node.js域名解析實(shí)現(xiàn)方法,結(jié)合實(shí)例形式詳細(xì)分析了node.js使用dns.lookup()及dns.resolve4()進(jìn)行域名解析的相關(guān)操作技巧與注意事項(xiàng),需要的朋友可以參考下2019-11-11
干凈卸載Windows的Node.js環(huán)境的方法
這篇文章主要介紹了如何干凈卸載Windows的Node.js環(huán)境的方法,文中通過(guò)圖文結(jié)合的方式講解的非常詳細(xì),對(duì)大家刪除Node.js環(huán)境有一定的幫助,需要的朋友可以參考下2025-01-01
package.json各個(gè)屬性說(shuō)明詳解
這篇文章主要介紹了package.json各個(gè)屬性說(shuō)明詳解，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-03-03
Node.js操作MongoDB數(shù)據(jù)庫(kù)實(shí)例分析
這篇文章主要介紹了Node.js操作MongoDB數(shù)據(jù)庫(kù),結(jié)合實(shí)例形式分析了node.js連接MongoDB數(shù)據(jù)庫(kù)以及增刪改查等相關(guān)操作技巧,需要的朋友可以參考下2020-01-01
獨(dú)立部署小程序基于nodejs的服務(wù)器過(guò)程詳解
這篇文章主要介紹了獨(dú)立部署小程序基于nodejs的服務(wù)器過(guò)程詳解，完全自定義的部署小程序服務(wù)器, 不依托于騰訊云服務(wù)器體系. 以阿里云服務(wù)器為基礎(chǔ)建立.服務(wù)器語(yǔ)言選用nodejs.,需要的朋友可以參考下2019-06-06
這篇文章主要介紹了Node.js?Webpack常見的模式,Webpack的另一個(gè)核心是Plugin?，Plugin是可以用于執(zhí)行更加廣泛的任務(wù)如打包優(yōu)化資源管理?環(huán)境變量注入等，需要的朋友可以參考下2022-10-10
NodeJs實(shí)現(xiàn)定時(shí)任務(wù)的示例代碼
本篇文章主要介紹了NodeJs實(shí)現(xiàn)定時(shí)任務(wù)的示例代碼，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-12-12
WebStorm是作為JS開發(fā)IDE存在的,并且支持流行的Node.js以及JQuery等js框架,下面這篇文章主要給大家介紹了關(guān)于如何從零開始在webstorm配置nodejs的相關(guān)資料,需要的朋友可以參考下2024-08-08
node.js實(shí)現(xiàn)身份認(rèn)證的示例代碼
本文主要介紹了 node.js實(shí)現(xiàn)身份認(rèn)證的示例代碼，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2022-04-04