跳转到主要内容

Intelmq-API是一个基于FastAPI的API,用于intelmq,这是一个IT安全团队用于收集和处理安全馈送解决方案。

项目描述

Tests Status Package Status

intelmq-api是基于FastAPI的API,用于intelmq项目。

关于安装、配置和使用intelmq-api的详细文档可以在intelmq文档中找到。

开发使用

您可以为项目创建一个虚拟环境,然后使用以下命令安装包

pip install -e .

为了开发目的,您可以使用scripts/run_dev.sh脚本来运行API。它在本地的8000端口上提供API服务,并监视文件变化,在变化时自动重新加载。

交互式文档在/docs端点上提供。

为了设置API配置,请使用您要使用的shell中的环境变量INTELMQ_API_CONFIG导出JSON配置文件的路径。有关配置参考,请检查intelmq_api/config.py和来自contrib/api-config.json的示例。

如果您已配置会话存储,则需要对每个请求进行授权。/v1/login返回授权令牌。您可以使用以下命令注册用户

./scripts/intelmq-api-adduser --user UserName

安全提示

在部署API时请谨慎操作。在当前阶段,它未设计用于在没有额外预防措施的情况下运行在公开端点上。

类型检查

可以使用mypy对代码进行类型检查。要运行类型检查器,请使用

mypy intelmq_api/

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源代码分发

此版本没有可用的源代码分发文件。请参阅 生成分发存档的教程

构建分发

intelmq_api-3.2.0-py3-none-any.whl (23.1 kB 查看哈希值)

上传时间 Python 3