ubuntu

如何在Ubuntu中安装Swagger

小樊
35
2025-12-20 03:55:01
栏目: 智能运维

在Ubuntu中安装Swagger,你可以选择安装Swagger UI或者Swagger Editor。以下是安装Swagger UI的步骤:

安装Swagger UI

  1. 更新系统包列表 打开终端并运行以下命令来更新你的包列表:

    sudo apt update
    
  2. 安装Swagger UI 你可以使用pip来安装Swagger UI。首先确保你已经安装了Python和pip。如果没有安装,可以使用以下命令安装:

    sudo apt install python3 python3-pip
    

    然后,使用pip安装Swagger UI:

    pip3 install swagger-ui-express
    
  3. 创建一个简单的Swagger UI应用 创建一个新的目录来存放你的Swagger UI应用,并进入该目录:

    mkdir swagger-ui-app
    cd swagger-ui-app
    

    创建一个名为app.py的文件,并添加以下内容:

    from flask import Flask
    from flask_swagger_ui import get_swaggerui_blueprint
    
    app = Flask(__name__)
    
    SWAGGER_URL = '/api-docs'
    API_URL = 'http://petstore.swagger.io/v2/swagger.json'  # 这里可以替换为你自己的API文档URL
    
    swaggerui_blueprint = get_swaggerui_blueprint(
        SWAGGER_URL,
        API_URL,
        config={
            'app_name': "Swagger UI"
        }
    )
    
    app.register_blueprint(swaggerui_blueprint, url_prefix=SWAGGER_URL)
    
    if __name__ == '__main__':
        app.run(debug=True)
    
  4. 运行应用 在终端中运行你的应用:

    python3 app.py
    

    打开浏览器并访问http://127.0.0.1:5000/api-docs,你应该能看到Swagger UI界面。

安装Swagger Editor

  1. 安装Swagger Editor 你可以使用Docker来安装Swagger Editor。首先确保你已经安装了Docker。如果没有安装,可以使用以下命令安装:
    sudo apt install docker.io
    
    然后,拉取Swagger Editor的Docker镜像并运行容器:
    docker pull swaggerapi/swagger-editor
    docker run -p 8080:8080 -d swaggerapi/swagger-editor
    
    打开浏览器并访问http://127.0.0.1:8080,你应该能看到Swagger Editor界面。

通过以上步骤,你可以在Ubuntu系统中成功安装并运行Swagger UI或Swagger Editor。

0
看了该问题的人还看了