ubuntu

ubuntu swagger如何进行网络配置

小樊
39
2025-06-11 00:16:04
栏目: 智能运维

在Ubuntu上配置Swagger主要涉及安装和配置Swagger Editor和Swagger UI,以及确保它们可以通过网络访问。以下是详细步骤:

安装Node.js和npm

首先,确保你的系统上已经安装了Node.js和npm。如果没有安装,可以通过以下命令进行安装:

sudo apt update
sudo apt install nodejs npm

安装Swagger Editor和Swagger UI

使用npm全局安装Swagger Editor和Swagger UI:

sudo npm install -g swagger-editornpm install -g swagger-ui

启动Swagger Editor和Swagger UI

  1. Swagger Editor:

    • 启动Swagger Editor后,访问 http://localhost:8080 使用你保存的Swagger YAML文件进行API文档的编辑和查看。
  2. Swagger UI:

    • 启动Swagger UI后,访问 http://localhost:3000,在页面中输入你的Swagger YAML文件的URL,然后点击“Explore”按钮查看和测试API。

配置Swagger

  1. 创建Swagger配置文件(例如 swaggerConfig.java):
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.yourpackage")) // 替换为你的控制器包路径
                .paths(PathSelectors.any())
                .build();
    }
}
  1. 访问Swagger UI
    • 启动你的Spring Boot应用程序后,你可以通过浏览器访问Swagger UI界面。默认情况下,可以通过以下URL访问:http://localhost:8080。这里假设你的应用程序运行在8080端口上。

使用Docker集成Swagger UI(可选)

如果你希望更方便地管理和部署Swagger,可以使用Docker:

  1. 安装Docker
sudo apt update
sudo apt install docker.io
  1. 拉取并运行Swagger UI Docker镜像
docker pull swaggerapi/swagger-ui-express
docker run -p 8080:8080 swaggerapi/swagger-ui-express

通过以上步骤,你就可以在Ubuntu上成功安装和配置Swagger,并进行API文档的生成和测试。

0
看了该问题的人还看了