117.info
人生若只如初见

Ubuntu如何搭建Swagger环境

在Ubuntu上搭建Swagger环境可以通过以下步骤完成:

1. 安装Node.js和npm

首先,确保你的系统上已经安装了Node.js和npm。你可以通过以下命令来安装它们:

sudo apt update
sudo apt install -y nodejs npm

验证安装是否成功:

node -v
npm -v

2. 安装Swagger Editor

你可以通过npm全局安装Swagger Editor:

sudo npm install -g http-server

然后,下载并解压Swagger Editor:

wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.16.1.tar.gz
tar -xvf v3.16.1.tar.gz
cd swagger-editor-3.16.1

启动Swagger Editor:

http-server -p 8080

访问http://localhost:8080来使用Swagger Editor。

3. 安装Swagger UI

同样,你可以通过npm全局安装Swagger UI:

sudo npm install -g swagger-ui

然后,下载并解压Swagger UI:

wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.48.0.tar.gz
tar -xvf v3.48.0.tar.gz
cd swagger-ui-3.48.0

启动Swagger UI:

npm install
node index.js

访问http://localhost:3000来使用Swagger UI。

4. 使用Springdoc(适用于Spring Boot项目)

如果你使用的是Spring Boot项目,推荐使用springdoc,它是一个自动生成API文档的工具,集成Swagger UI和Redoc。

添加以下依赖到你的pom.xml


    org.springdoc
    springdoc-openapi-starter-webmvc-ui
    2.1.0

然后在你的主类上添加@EnableSpringDoc注解:

import io.swagger.v3.oas.annotations.EnableSpringDoc;

@SpringBootApplication
@EnableSpringDoc
public class YourApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourApplication.class, args);
    }
}

启动你的Spring Boot应用,然后访问http://localhost:8080/swagger-ui/来查看自动生成的API文档。

以上步骤应该能帮助你在Ubuntu上成功搭建Swagger环境。如果你遇到任何问题,请检查网络连接和防火墙设置,并确保所有依赖项都已正确安装。

未经允许不得转载 » 本文链接:https://www.117.info/ask/fe3f6AzsKCQFSAlE.html

推荐文章

  • ubuntu如何使用nodejs搭建服务器

    在Ubuntu上使用Node.js搭建服务器的步骤如下: 安装Node.js:
    首先,你需要在你的Ubuntu系统上安装Node.js。你可以使用以下命令来安装Node.js和npm(Node.j...

  • Ubuntu VNC如何文件传输

    在Ubuntu系统中,通过VNC进行文件传输可以通过以下几种方法实现:
    使用VNC Viewer进行文件传输 连接到VNC服务器: 在本地计算机上安装VNC客户端软件,如Tig...

  • ubuntu informix权限如何管理

    在Ubuntu系统中管理Informix数据库的权限,通常涉及以下几个方面:
    用户和用户组管理 创建用户:可以使用 useradd 命令创建新用户,例如:sudo useradd myd...

  • Ubuntu Informix网络连接问题怎么解决

    在Ubuntu系统上连接Informix数据库服务器时,可能会遇到各种网络连接问题。以下是一些常见的解决方法:
    检查网络连接 使用 ping 命令检查与服务器之间的网络...

  • 如何通过nohup日志优化centos系统配置

    通过nohup命令运行的进程通常会在后台持续运行,即使用户退出登录也不会中断。这些进程的输出通常会被重定向到一个日志文件中,以便于后续查看和分析。要优化Cen...

  • 如何在Linux上安装LAMP环境

    在Linux上安装LAMP环境(Linux, Apache, MySQL, PHP)可以通过以下步骤完成:
    1. 安装Apache
    首先,更新系统包并安装Apache:
    sudo apt update

  • Ubuntu VirtualBox虚拟机如何更新

    要在Ubuntu VirtualBox虚拟机中更新系统,您可以按照以下步骤操作:
    更新系统软件包 打开终端窗口。
    运行以下命令更新系统软件包列表:sudo apt-get u...

  • LNMP安全设置有哪些要点

    LNMP安全设置的要点包括以下几个方面: 文件和目录权限: 使用 chmod 和 chown 命令设置合理的文件和目录权限。例如,目录权限可以设置为 755,文件权限可以设置...