117.info
人生若只如初见

如何用Ubuntu Swagger测试API

在Ubuntu系统上使用Swagger测试API,通常涉及以下几个步骤:

1. 安装Node.js和npm

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

sudo apt update
sudo apt install -y nodejs npm

验证安装是否成功:

node -v
npm -v

2. 安装Swagger UI

有几种方法可以在Ubuntu上安装Swagger UI:

方法一:从GitHub克隆并运行

git clone https://github.com/swagger-api/swagger-ui.git
cd swagger-ui
npm install
npm start

然后,在浏览器中访问 http://localhost:3000/swagger-ui/index.html 即可看到Swagger UI界面。

方法二:使用npm全局安装http-server

sudo npm install -g http-server

然后,解压Swagger UI的源码包(可以从Swagger官网下载),并将解压后的dist目录中的文件复制到Swagger UI源码目录中的public文件夹。接着,运行以下命令启动http-server:

http-server -p 8080

在浏览器中访问 http://localhost:8080 即可看到Swagger UI界面。

3. 配置Swagger

如果你的后端服务是基于Spring Boot的,可以使用springfox-swagger2springfox-swagger-ui来集成Swagger。首先,在pom.xml中添加依赖:


    io.springfox
    springfox-swagger2
    2.9.2


    io.springfox
    springfox-swagger-ui
    2.9.2

然后,创建一个配置类来启用Swagger:

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.any())
                .paths(PathSelectors.any())
                .build();
    }
}

启动Spring Boot应用后,访问 http://localhost:8080/swagger-ui.html 即可看到Swagger UI界面,其中展示了项目中定义的所有API接口及其详细信息。

4. 测试API

在Swagger UI界面中,可以找到你定义的API接口,点击相应的接口,然后点击“Try it out”按钮即可测试API。你可以在“Params”部分输入参数,在“Body”部分输入请求体(如果是POST请求),然后点击“Execute”按钮执行请求并查看响应结果。

通过以上步骤,你就可以在Ubuntu系统上使用Swagger来测试API了。

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

推荐文章

  • Ubuntu Minimal虚拟机安装

    在Ubuntu系统中,Minimal安装是一种最小化的安装方式,它只包含最基本的系统组件,适用于需要精简系统的用户。以下是在Ubuntu系统中进行Minimal虚拟机安装的步骤...

  • ubuntu时间戳如何重置

    在Ubuntu系统中,时间戳通常是指系统的时间。如果你想要重置系统时间,可以通过以下几种方法: 使用图形用户界面(GUI): 打开系统设置(System Settings)。
    ...

  • Ubuntu SFTP如何更新与升级

    在Ubuntu系统上,SFTP(SSH文件传输协议)的更新与升级通常涉及整个系统的更新,因为SFTP是OpenSSH软件包的一部分。以下是更新与升级Ubuntu系统的一般步骤,这些...

  • ubuntu里copir目录命令怎么操作

    在 Ubuntu 中,要复制目录及其内容,可以使用 cp 命令,并加上 -r(递归)选项。以下是基本语法:
    cp -r 源目录 目标目录 例如,如果你想复制名为 source_d...

  • 如何在Debian上解决Jenkins内存溢出问题

    在Debian上解决Jenkins内存溢出问题,可以尝试以下几种方法:
    增加服务器内存
    如果服务器内存不足,最直接的方法是增加服务器的物理内存。
    配置J...

  • Debian Filezilla日志查看方法

    在Debian系统中,可以通过以下几种方法查看FileZilla的日志: 使用命令行工具查看日志文件: 打开终端(Terminal)。
    输入以下命令查看FileZilla的日志文件,...

  • Ubuntu Recycle怎样优化存储空间

    Ubuntu系统自带的回收站(Recycle)功能主要用于存储已删除的文件和文件夹,以便用户在需要时能够恢复。然而,回收站本身并不提供直接的优化存储空间的功能。要优...

  • Debian Postman如何安装

    在Debian系统上安装Postman有多种方法,以下是其中两种常用的方法:
    通过Snap安装Postman 安装Snapd服务: sudo apt update
    sudo apt install snapd 安...