Spring Boot SAPI Starter 使用教程

Spring Boot SAPI Starter 使用教程

spring.boot.sapi.starter🍃一个简单的Restful API输出工具，只需一行配置，即可将接口中的所有API接口及参数全部以结构化的方式输出的页面上。项目地址:https://gitcode.com/gh_mirrors/sp/spring.boot.sapi.starter

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

spring.boot.sapi.starter/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   ├── com/
│   │   │   │   ├── xiaour/
│   │   │   │   │   ├── spring/
│   │   │   │   │   │   ├── boot/
│   │   │   │   │   │   │   ├── sapi/
│   │   │   │   │   │   │   │   ├── autoconfigure/
│   │   │   │   │   │   │   │   ├── starter/
│   │   │   │   │   │   │   │   ├── SapiProperties.java
│   │   │   │   │   │   │   │   ├── SapiStarterApplication.java
│   │   ├── resources/
│   │   │   ├── application.properties
│   │   │   ├── application-dev.properties
│   │   │   ├── application-prod.properties
├── pom.xml

目录结构说明

• src/main/java/com/xiaour/spring/boot/sapi/: 主要代码目录，包含自动配置和启动类。
  • autoconfigure/: 自动配置相关类。
  • starter/: 启动器相关类。
  • SapiProperties.java: 配置属性类。
  • SapiStarterApplication.java: 主启动类。
• src/main/resources/: 资源文件目录，包含配置文件。
  • application.properties: 默认配置文件。
  • application-dev.properties: 开发环境配置文件。
  • application-prod.properties: 生产环境配置文件。
• pom.xml: Maven 项目配置文件。

2. 项目的启动文件介绍

SapiStarterApplication.java

package com.xiaour.spring.boot.sapi;

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

@SpringBootApplication
public class SapiStarterApplication {

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

启动文件说明

• SapiStarterApplication.java 是项目的入口类，使用 @SpringBootApplication 注解标记，表示这是一个 Spring Boot 应用。
• main 方法中调用 SpringApplication.run 方法启动应用。

3. 项目的配置文件介绍

application.properties

# 应用名称
spring.application.name=sapi-starter

# 服务器端口
server.port=8080

# SAPI 配置
sapi.enabled=true
sapi.base-url=http://example.com

配置文件说明

• application.properties: 默认配置文件，包含应用名称、服务器端口和 SAPI 相关配置。
  • spring.application.name: 应用名称。
  • server.port: 服务器端口。
  • sapi.enabled: 是否启用 SAPI。
  • sapi.base-url: SAPI 基础 URL。

application-dev.properties

# 开发环境配置
server.port=8081
sapi.base-url=http://dev.example.com

application-prod.properties

# 生产环境配置
server.port=8082
sapi.base-url=http://prod.example.com

环境配置文件说明

• application-dev.properties: 开发环境配置文件，覆盖默认端口和 SAPI 基础 URL。
• application-prod.properties: 生产环境配置文件，覆盖默认端口和 SAPI 基础 URL。

通过以上配置文件，可以根据不同的环境进行灵活配置。

spring.boot.sapi.starter🍃一个简单的Restful API输出工具，只需一行配置，即可将接口中的所有API接口及参数全部以结构化的方式输出的页面上。项目地址:https://gitcode.com/gh_mirrors/sp/spring.boot.sapi.starter