MARS-Curiosity Delphi REST Library 安装与使用教程

1. 项目目录结构及介绍

MARS-Curiosity 是一个面向 Delphi 开发者的轻量级RESTful Web服务库。其目录结构设计简洁，便于理解和扩展。下面是该库的基本目录结构：

- MARS
    ├── Contributing.md   # 贡献指南
    ├── Docs               # 文档资料
    ├── Gitmodules         # Git 子模块信息
    ├── Gitignore          # 忽略文件列表
    ├── LICENSE            # 许可证文件
    ├── README.md          # 项目主读我文件
    ├── Sources            # 源代码目录
        └── MARScmd       # 可能包含命令行工具相关的源代码
        └── ...           # 其他子目录，如包含了核心引擎、HTTP服务器等组件的源码
    ├── Tests              # 测试相关文件
    ├── Utils              # 辅助工具或脚本
    └── Www                # 可能存放Web相关资源或示例

每个主要功能模块通常在 Sources 目录下有自己的子目录，确保代码的组织性和模块化。

2. 项目的启动文件介绍

在使用MARS-Curiosity创建REST服务时，入口点通常位于一个新的Delphi Console Application中。虽然具体的启动文件名称可能由用户自定义，但基础模板的程序通常名为 Project1.dpr 或开发者指定的名字。一个简单的启动示例代码展示如下：

program Mars1;
uses
  System.SysUtils,
  MARS.Core.Engine,
  MARS.http.Server.Indy,
  ...
type
  [Path('helloworld')]
  THelloWorldResource = class
    [GET, Produces(TMediaType.TEXT_PLAIN)]
    function SayHelloWorld: string;
  end;

function THelloWorldResource.SayHelloWorld: string;
begin
  Result := 'Hello World. Here is MARS Curiosity';
end;

var
  FEngine: TMARSEngine;
  FServer: TMARShttpServerIndy;
begin
  // 注册资源类
  MARS.Core.Registry.TMARSResourceRegistry.Instance.RegisterResource<THelloWorldResource>;

  // 创建并配置引擎
  FEngine := TMARSEngine.Create;
  try
    FEngine.BasePath := '/rest';
    FEngine.Port := 8080;
    FEngine.AddApplication('DefaultAPI', '/default', ['*THelloWorldResource']);

    // 初始化并运行服务器
    FServer := TMARShttpServerIndy.Create(FEngine);
    FServer.Active := True;
    Writeln('Server is running. Press Enter to stop.');
    Readln;
    FServer.Active := False;
  finally
    FreeAndNil(FServer);
    FreeAndNil(FEngine);
  end;
end.

这个程序展示了如何快速搭建一个简单的REST服务端，通过注册资源类和配置服务端口来启动服务。

3. 项目的配置文件介绍

MARS-Curiosity 的配置并不直接依赖于传统意义上的外部配置文件（如.ini或.xml），而是更多地通过代码进行配置。这意味着，大部分的设置和配置是在程序内部完成的，比如在启动文件中设置服务的基础路径、监听端口号、应用程序路径等。尽管如此，对于复杂的部署需求，可以通过环境变量或者创建初始化脚本来间接实现配置的外部管理，但这需要开发者自行实现逻辑来读取这些外部设定。

如果您需要更灵活的配置方式，可以通过定制化类或利用Delphi提供的方法，例如环境变量、 IniFiles 对象或数据库来加载配置，但这不在项目的标准流程之内，需额外编码实现。

---

此文档提供了MARS-Curiosity Delphi REST Library的基本框架介绍，包括其目录结构、如何开始一个项目以及配置概述。开发者可以根据实际需求调整和扩展上述内容。