目录
在Linux上配置Swagger UI接口后,您可以按照以下步骤进行操作:Node.js和NPM
Swaggerui通常使用node.js运行。 首先,确保系统上安装了NODE.JS和NPM。 如果您不想安装它,则可以通过以下命令安装它:
8SudoAttUpdate
sudo apt install nodejs npm
10🔥
2。 Swaggeruiexpress12🔥
swaggeruiExpress是Express应用程序的Swagger UI中间件。 可以使用NPM安装:
16🔥npm安装Swagger-UI-Express
18🔥
3。创建一个简单,快速的应用程序
创建了一个新目录,并创建一个App.js23🔥file。
26Mkdirswagge-ui-demo Cd30🔥swagger-ui-demo Touch3222🔥App.js 编写Express应用程序代码
InRequire('swagger-ui-express');
Const57🔥Yaml
=Require('yamljs'12🔥);
6869🔥load('./swagger.yaml');
ConstApp=Express76🔥(); //('/api-docs'82🔥,Swaggerui.Serve,Swaggerui.85🔥Setup(SwaggerDocument)); process.env95🔥port|| 3000; app.侦听(port,()=>{[h Console106🔥.107🔥log(()'2.0'126🔥Info:Title:131Sample132133Description: 137139🔥Sample141142🔥TO144145🔥Demstrate146148149🔥UII
157158🔥Basepath:161🔥/api-docs-🔥16666Httpp168169🔥Paths: get:MMMARYusers
Responses:
'200':'200':🔥1871871871818181818187.🔥🔥 Schema:
Type:201🔥Array
ITEMS:
$ REF:207🔥'USSINGS/USER'ISTES/USER'IDESTE8🔥
-DEFINITIONS:
PROPERTIES:PROPERTIES:PROPERTIE:
ID:histy: 🔥222225🔥Format:227🔥INT6414🔥222228🔥
TYPE:232String
Email:Email:
246🔥
6。通过在项目目录中运行以下命令:
252🔥nodeApp.js254🔥
254🔥🔥25254🔥🔥2555🔥77。 转到Swagger UI接口
开放您的浏览器,转到258🔥Http:// localhost:3000/api-docs259🔥看到Swagger UI接口并浏览并浏览并测试API。
8。 nginx(可选)
如果您想通过nginx代理Swagger UI接口,则可以按照以下步骤操作。配置:
- 267🔥Installnginx:
270🔥SudoAttinstall nnginx
280🔥
286Server🔥2888🔥{
Listen29029180🔥292,
Proxy_pass298🔥Http:// localhost:3000;
Proxy_set_header🔥300host$ host3021;
Proxy_set_headerX-Forwarded-For$Proxy_add_x_forwarded_for;
Proxy_set_headerX-Forwarded-Proto$ scheme316🔥
-
启用设置:
322🔥Sudonginx 326🔥
now,它是Http://your_domain.com/api-docs
33332🔥🔥33332🔥 Http:///your_domain.com/api-domain.com/api-docs,331,331,331🔥333333333 33332🔥
336🔥
上述内容来自Internet,并不代表此站点的所有视图! 关注:zhujipindao .com
评论前必须登录!
注册