初识Java:创建项目并引入Swagger

1. 创建项目

依赖目前就用到这两个 (暂时还未连接数据库 driver 还没装)

2. 导入swagger3

直接上3的代码,2有兴趣的自行研究

1)加入pom依赖

<!-- Swagger3 -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.2.0</version>
</dependency>

2)配置 swagger

package org.wq.study.javastudyserver.config;

import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class OpenAPIConfig {
    @Bean
    public OpenAPI openAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("测试项目")
                        .description("自定义项目集成 Swagger3")
                        .version("v1"))
                .externalDocs(new ExternalDocumentation()
                        .description("项目API文档")
                        .url("/"));
    }
}

至此,运行项目即可。

访问 swagger 地址:http://localhost:8080/swagger-ui/index.html#/

  • 24
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
Swagger 1.5.20 导入是指将 Swagger 1.5.20 版本的工具导入到项目使用。Swagger 是一种用于构建、文档化和使用 RESTful API 的开源工具。下面是一种常见的导入步骤: 1. 下载 Swagger 1.5.20 版本的 jar 包。你可以在 Swagger 的官方网站或者其他可靠的资源网站上找到该版本的下载链接。下载完成后,将 jar 包保存到项目合适的位置。 2. 将 jar 包添加到项目的依赖。具体的添加方式取决于项目使用的构建工具。如果是 Maven 项目,你可以在项目的 pom.xml 文件添加以下依赖项: ``` <dependency> <groupId>io.swagger</groupId> <artifactId>swagger-core</artifactId> <version>1.5.20</version> </dependency> ``` 3. 配置 Swagger。在项目的配置文件,根据你的需求配置 Swagger 的参数。例如,你可以指定 API 文档的标题、描述、版本等信息。你还可以配置 Swagger 显示 API 文档的路径,以及是否在 Swagger UI 显示默认的 API 文档。 4. 在代码使用 Swagger 注解。为了生成 API 文档,你需要在你的代码使用 Swagger 提供的注解。例如,你可以使用 `@Api` 注解来定义一个控制器的基本信息,使用 `@ApiOperation` 注解来定义一个具体的 API 操作。 5. 启动项目并访问 Swagger UI。当项目启动后,你可以通过访问指定的 Swagger UI URL,来查看生成的 API 文档。Swagger UI 提供了一个直观的界面,用于显示 API 文档的信息和操作。 总的来说,导入 Swagger 1.5.20 版本就是下载相应的 jar 包,添加到项目的依赖,然后在配置文件和代码使用相应的注解来生成和展示 API 文档。这样可以帮助开发者更好地了解、测试和使用项目的 RESTful API。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值