Hango API 网关使用教程

Hango API 网关使用教程

hango-gatewayHango API Gateway, build on Envoy & Istio.项目地址:https://gitcode.com/gh_mirrors/ha/hango-gateway

1. 项目的目录结构及介绍

Hango API 网关的目录结构如下：

hango-gateway/
├── example/
│   └── expose_api_with_ui/
│       └── zh_CN/
│           └── md/
├── docs/
│   ├── Home.md
│   ├── 快速上手.md
│   ├── 用户指南.md
│   ├── 组件配置.md
│   ├── 开发手册.md
│   └── Blog.md
├── src/
│   ├── controller/
│   ├── service/
│   ├── model/
│   └── utils/
├── config/
│   ├── application.yml
│   └── logback.xml
├── Dockerfile
├── LICENSE
├── README.md
└── pom.xml

目录结构介绍

• example/: 包含一些示例代码和文档。
• docs/: 包含项目的文档，如快速上手、用户指南、组件配置、开发手册等。
• src/: 包含项目的源代码，分为控制器、服务、模型和工具类。
• config/: 包含项目的配置文件，如应用配置和日志配置。
• Dockerfile: 用于构建 Docker 镜像的文件。
• LICENSE: 项目的许可证文件。
• README.md: 项目的介绍文档。
• pom.xml: Maven 项目的配置文件。

2. 项目的启动文件介绍

Hango API 网关的启动文件主要是 src/main/java/com/hango/gateway/Application.java。这个文件包含了项目的主类，负责启动整个应用程序。

package com.hango.gateway;

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

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

启动文件介绍

• @SpringBootApplication: 这是一个组合注解，包含了 @Configuration、@EnableAutoConfiguration 和 @ComponentScan，用于简化 Spring Boot 应用的配置。
• main 方法：这是应用程序的入口点，通过 SpringApplication.run 方法启动 Spring Boot 应用。

3. 项目的配置文件介绍

Hango API 网关的配置文件主要位于 config/ 目录下，包括 application.yml 和 logback.xml。

application.yml

application.yml 文件包含了应用的基本配置，如服务器端口、数据库连接、日志级别等。

server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/hango
    username: root
    password: root

logging:
  level:
    com.hango.gateway: DEBUG

logback.xml

logback.xml 文件用于配置日志输出，包括日志格式、输出路径等。

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="debug">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

配置文件介绍

• application.yml: 包含服务器端口、数据库连接和日志级别等配置。
• logback.xml: 配置日志输出格式和路径。

以上是 Hango API 网关的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用 Hango API 网关。

hango-gatewayHango API Gateway, build on Envoy & Istio.项目地址:https://gitcode.com/gh_mirrors/ha/hango-gateway