jnstockley/api

镜像概述

这是一个使用FastAPI框架用Python编写的自定义API，旨在通过RESTful API改进任务完成流程。该API提供高性能、易用的接口，支持与PostgreSQL数据库交互，并通过API密钥实现访问控制。

核心功能和特性

• 基于FastAPI构建，提供异步支持和自动生成的API文档
• 集成PostgreSQL数据库连接，支持数据持久化
• API密钥认证机制，保障接口安全（除健康检查接口外）
• 可配置容器及PostgreSQL数据库时区

使用场景和适用范围

适用于需要通过自定义API接口管理任务、处理数据的场景，适合开发者构建轻量级API服务，可集成到各类需要RESTful接口支持的应用系统中。

使用方法和配置说明

环境准备

最简单的部署方式是基于项目提供的https://github.com/jnstockley/api/blob/dev/compose.yml%E5%92%8Chttps://github.com/jnstockley/api/blob/dev/template.env%E6%96%87%E4%BB%B6%EF%BC%8C%E5%B0%86%60template.env%60%E9%87%8D%E5%91%BD%E5%90%8D%E4%B8%BA%60.env%60%E5%B9%B6%E9%85%8D%E7%BD%AE%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E3%80%82

环境变量配置

部署示例

使用docker-compose部署

1. 下载项目的compose.yml和template.env文件
2. 复制template.env为.env并配置环境变量：

   bash
   cp template.env .env
   # 编辑.env文件设置API_KEY、DATABASE_URL等参数
   

3. 启动服务：

   bash
   docker-compose up -d
   

访问验证

服务启动后，通过以下地址访问健康检查接口验证部署状态：

http://<IP>:5000/health-check

若配置正确，将返回：

json
{"status":"ok"}