ExchangeRatesAPI 安装与使用指南

目录结构及介绍

在克隆或下载 ExchangeRatesAPI 开源项目之后, 其核心目录结构如下:

exchangeratesapi/
├── config/
│   └── settings.py
├── exchangeratesapi/
│   ├── __init__.py
│   ├── api.py
│   ├── models.py
│   └── utils.py
├── run.py
└── tests/
    └── test_api.py

config/settings.py

这是项目的配置文件，包含了数据库连接设置、API密钥等敏感信息。

exchangeratesapi/api.py

在这里定义了应用程序的主要路由和功能，API请求处理位于这个文件中。

exchangeratesapi/models.py

这里包含了所有数据模型类定义，用于与数据库交互。

exchangeratesapi/utils.py

工具函数被放在此处，例如日期转换、货币代码验证等功能都在此实现。

run.py

这是一个脚本文件，用于运行 Flask 应用程序。您可以在此文件中修改默认的运行参数。

tests/test_api.py

测试模块以确保 API 的正确性。

启动文件介绍

run.py 文件是启动 ExchangeRatesAPI 应用的关键文件。

from flask import Flask
from config.settings import CONFIG
from exchangeratesapi.api import init_app

app = Flask(__name__)
app.config.from_object(CONFIG)

if __name__ == '__main__':
    app.run(debug=True)

在这个文件里:

• 导入了Flask框架和应用程序的相关组件
• 从配置文件中导入设置
• 初始化应用程序实例并加载配置项
• 最终，在 if name == 'main' 块内执行应用，使它在本地环境中可运行

配置文件介绍

config/settings.py 包含以下关键配置属性：

import os

class Config:
    DEBUG = False
    TESTING = False
    SECRET_KEY = 'your-secret-key'
    DATABASE_URI = 'sqlite:///rates.db'

class DevelopmentConfig(Config):
    DEBUG = True
    DATABASE_URI = 'sqlite:///' + os.path.join(os.getcwd(), 'dev_rates.db')

class TestingConfig(Config):
    TESTING = True
    DATABASE_URI = 'sqlite:///:memory:'

配置类包括:

• Config: 基础配置，其中包含了通用的设置如SECRET_KEY 和 DATABASE_URI.
• DevelopmentConfig: 继承自Config, 此配置适应于开发环境，启用了调试模式并在当前工作目录创建一个临时数据库。
• TestingConfig: 测试专用配置，包含内存中的 SQLite 数据库，非常适合单元测试。

要改变应用的配置，可以在 run.py 中通过更改app.config.from_object(CONFIG) 行来实现。这里的 CONFIG 变量应该指向您选择的配置类之一（例如，DevelopmentConfig）。

遵循以上指导，你可以成功安装和运行 ExchangeRatesAPI 开源项目。