centos

centos swagger配置步骤

小樊
86
2025-02-14 04:24:15
栏目: 智能运维

在CentOS上配置Swagger的步骤如下:

安装Node.js和npm

首先,你需要在CentOS系统上安装Node.js和npm。可以通过以下命令来完成安装:

yum install gcc-c make -y
curl -sL https://rpm.nodesource.com/setup_12.x | bash -
yum install nodejs -y

验证安装是否成功:

node -v
npm -v

安装Swagger-Editor和Swagger-UI

  1. 安装Swagger-Editor

    创建一个新的目录来存放Swagger-Editor,并下载对应版本的Swagger-Editor源码包:

    mkdir /opt/swagger
    cd /opt/swagger
    wget https://github.com/swagger-api/swagger-editor/archive/v3.14.0.tar.gz
    tar -xzf v3.14.0.tar.gz
    cd swagger-editor-3.14.0
    npm install -g http-server
    

    启动Swagger-Editor服务:

    http-server -p 8080
    

    访问http://<your-server-ip>:8080确认可以访问。

  2. 安装Swagger-UI

    在Swagger目录中,下载并解压Swagger-UI的最新版:

    cd /opt/swagger
    wget https://github.com/swagger-api/swagger-ui/archive/v3.34.0.tar.gz
    tar -xzf v3.34.0.tar.gz
    cd swagger-ui-3.34.0
    npm init -y
    npm install express --save
    mkdir public
    cp -r swagger-ui-3.34.0/dist/* public/
    

    创建index.js文件并监听端口3000:

    vim index.js
    

    修改以下内容:

    var express = require('express');
    var app = express();
    var http = require('http');
    app.use('/static', express.static('public'));
    app.get('/', function (req, res) { res.send('Hello World!'); });
    app.listen(3000, function () { console.log('Example app listening on port 3000!'); });
    

    启动index.js服务:

    node index.js
    

    访问http://<your-server-ip>:3000/static/index.html确认可以访问。

配置Swagger-UI以显示自定义接口文档

  1. 在Swagger-Editor中编写你的接口文档,并将生成的JSON文件保存到本地。

  2. 将JSON文件上传至/opt/swagger/public目录。

  3. 修改/opt/swagger/public/index.html文件中的URL,将其指向你的JSON文件:

    url: "/static/你的JSON文件名"
    
  4. 刷新页面即可查看自定义的接口文档。

以上步骤应该可以帮助你在CentOS系统上成功配置Swagger。如果在配置过程中遇到任何问题,请参考相关的官方文档或寻求社区帮助。

0
看了该问题的人还看了