一、相关技术栈版本概览

前提还是需要具备JAVA开发的基础概念，比如安装JDK环境。

二、整合相关技术栈

1. 创建空项目

使用 Spring Initializr 「https://start.spring.io/」快速创建Spring项目

在 Dependencies 对话框中搜索并添加 web 依赖关系，如屏幕截图所示。点击“生成”按钮，下载压缩包，并将其解压缩到计算机本地。

2. 编写基础的 Gradle 相关脚本

以下按相对项目的根目录进行说明，如文件不存在 可以手动创建：

• gradle.properties

# 当前项目版本
projectVersion=0.1.0-SNAPSHOT

# SpringBoot版本
springbootVersion=3.3.2

# JDK最低版本
jdkVersion=17

• build.gradle

buildscript {
    repositories {
        mavenLocal()
        maven { url "https://maven.aliyun.com/repository/public/" }
    }

    dependencies {
        /* 添加插件依赖路径（通过jar方式） */
        classpath "org.springframework.boot:spring-boot-gradle-plugin:${springbootVersion}"
    }
}

allprojects {
    apply plugin: "idea"
    apply plugin: "java"
    apply plugin: "org.springframework.boot"
    apply plugin: "io.spring.dependency-management"

    group = 'com.app4j.stack'
    version = projectVersion

    java {
        toolchain {
            languageVersion = JavaLanguageVersion.of(jdkVersion)
        }
    }

    configurations {
        // 排除tomcat
        all*.exclude module: 'spring-boot-starter-tomcat'
        compileOnly {
            extendsFrom annotationProcessor
        }
    }

    repositories {
        mavenLocal()
        maven { url "https://maven.aliyun.com/repository/public/" }
    }

    dependencies {
        // Lombok
        compileOnly 'org.projectlombok:lombok'
        annotationProcessor 'org.projectlombok:lombok'
        // Spring Web
        implementation 'org.springframework.boot:spring-boot-starter-web'
        // 使用undertow 替换tomcat
        implementation 'org.springframework.boot:spring-boot-starter-undertow'
    }
}

3. 创建 Springboot 启动类

com.app4j.web.WebApplication

package com.app4j.web;

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;

/**
 * @author eric.hao
 * @since 2024/07/18
 */
@Slf4j
@SpringBootApplication
public class WebApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(WebApplication.class).run(args);
        log.info("[App4j] Application Started.");
    }
}

ok 项目这就可以正式启动啦！

4. 整合 Swagger

只需一步即可！引入 Knife4j Swagger 增加工具包：

dependencies {
    // Swagger
    implementation 'com.github.xiaoymin:knife4j-openapi3-jakarta-spring-boot-starter:4.5.0'
}

让我们添加一个接口，测试下 swagger 的效果：

package com.app4j.web.knife4j;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author eric.hao
 * @since 2024/07/27
 */
@RestController
@RequestMapping("/demo")
@Tag(name = "示例接口")
public class Knife4jController {

    @Operation(summary = "向客人问好")
    @PostMapping("/sayHi")
    public ResponseEntity<?> sayHi(@RequestParam(value = "name") String name) {
        return ResponseEntity.ok("Hi:" + name);
    }
}

访问接口文档的本地地址：http://127.0.0.1:8080/doc.html

重要提示：为什么这次不用配置Docket Bean，就可以看到接口清单？

Knife4j 自4.0版本，下面的配置在 knife4j-openapi2-spring-boot-starter 中仍然需要如此配置，而在 knife4j-openapi3-spring-boot-starter 和 knife4j-openapi3-jakarta-spring-boot-starter 则不需要！！！

以上，我们完成了一个新的网站项目的初始化，并查看网站项目的OpenAPI！

关注点赞收藏不迷路！！振锁会持续给大家分享大厂一线的开发经验，手把手从0到架构设计！成为独当一面的多面手！！