实习记录2024.1.25

1.了解git流程

一般git merge，不用git rebase，防止修改步骤丢失

2.了解openAPI和openAPI generator

openAPI是一种规范，也叫Swagger。

在java里主要有两种方式，常见的是 Swagger Annotations 和 Swagger Codegen。

2.1添加 Swagger Annotations 依赖

<dependency>
    <groupId>io.swagger.core.v3</groupId>
    <artifactId>swagger-annotations</artifactId>
    <version>2.1.10</version>
</dependency>

2.2 Swagger Annotations

有点类似于在swaggo那篇文章中的用法，用注解（java）/注释（golang）来对某个路由处理函数（比如java的Controllor层或者go的路由层）进行规范，规定其各个参数的范围。

使用 Swagger Annotations 描述 API： 在你的代码中，使用 Swagger Annotations 描述 API 的信息。这些注解包括 @Api, @ApiOperation, @ApiParam, 等等。通过这些注解，你可以定义路径、操作、请求参数、响应等信息。

@Path("/users")
@Api(value = "User API")
public class UserController {

    @GET
    @Path("/{userId}")
    @ApiOperation(value = "Get user by ID")
    @ApiParam(value = "ID of the user", required = true)
    public Response getUserById(@PathParam("userId") long userId) {
        // Implementation
    }
}

2.3 Swagger Codegen

使用 Swagger Codegen 生成文档： Swagger Codegen 是一个用于生成 API 文档、客户端库和服务器存根的工具。你可以通过命令行或 Maven 插件集成 Swagger Codegen。以下是 Maven 插件的示例

<build>
    <plugins>
        <plugin>
            <groupId>io.swagger.codegen.v3</groupId>
            <artifactId>swagger-codegen-maven-plugin</artifactId>
            <version>3.0.27</version>
            <executions>
                <execution>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                    <configuration>
                        <inputSpec>${project.basedir}/src/main/resources/openapi.yaml</inputSpec>
                        <language>java</language>
                        <output>${project.build.directory}/generated-sources/swagger</output>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

在上述配置中，inputSpec 指定了 OpenAPI 规范的位置，language 指定了生成的代码语言，output 指定了生成代码的目录。

2.4保存

查看生成的文档： Swagger Codegen 将根据你的代码和注解生成 OpenAPI 规范，你可以将生成的规范导出为 JSON 或 YAML 文件。然后，你可以使用 Swagger UI 或其他 Swagger 相关工具来查看和交互式地浏览生成的 API 文档。

这是一个简单的使用 Swagger 在 Java 中描述和生成 API 文档的流程。具体的步骤和工具版本可能因项目配置而异。确保查看 Swagger Annotations 和 Swagger Codegen 的官方文档，以获取更详细的信息和适用于你项目的配置。

3.了解testng框架和 mockito工具

这两个都是用来做单元测试的

4.JEXL（java表达式语言）

一种脚本，配合java使用，工作经常写。