开源项目 hk-modding/api 使用教程

1. 项目目录结构及介绍

hk-modding/api
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── hkmodding
│   │   │           └── api
│   │   │               ├── controllers
│   │   │               ├── models
│   │   │               ├── services
│   │   │               └── ApiApplication.java
│   │   └── resources
│   │       ├── application.properties
│   │       └── static
│   └── test
│       └── java
│           └── com
│               └── hkmodding
│                   └── api
│                       └── ApiApplicationTests.java
├── .gitignore
├── LICENSE
├── README.md
└── pom.xml

目录结构说明

• src/main/java: 存放项目的Java源代码。
  • com/hkmodding/api: 项目的主要代码包。
    • controllers: 存放控制器类，处理HTTP请求。
    • models: 存放数据模型类。
    • services: 存放服务类，处理业务逻辑。
    • ApiApplication.java: 项目的启动类。
  • resources: 存放项目的配置文件和静态资源。
    • application.properties: 项目的配置文件。
    • static: 存放静态资源文件。
• src/test/java: 存放项目的测试代码。
  • com/hkmodding/api: 测试代码包。
    • ApiApplicationTests.java: 项目的测试类。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目的开源许可证。
• README.md: 项目的说明文档。
• pom.xml: Maven项目的配置文件。

2. 项目启动文件介绍

ApiApplication.java

package com.hkmodding.api;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ApiApplication {

    public static void main(String[] args) {
        SpringApplication.run(ApiApplication.class, args);
    }
}

启动文件说明

• ApiApplication.java 是项目的启动类，使用了Spring Boot的@SpringBootApplication注解，表示这是一个Spring Boot应用程序。
• main方法中调用了SpringApplication.run方法来启动Spring Boot应用程序。

3. 项目配置文件介绍

application.properties

# 服务器配置
server.port=8080

# 数据库配置
spring.datasource.url=jdbc:mysql://localhost:3306/hkmodding
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# JPA配置
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5Dialect

配置文件说明

• server.port: 配置服务器的端口号，默认为8080。
• spring.datasource: 配置数据库连接信息，包括数据库URL、用户名、密码和驱动类名。
• spring.jpa: 配置JPA（Java Persistence API）的相关属性，如Hibernate的DDL自动更新、是否显示SQL语句以及数据库方言。

通过以上配置，项目可以正常启动并连接到数据库。