OpenAPI Security Scanner 使用教程

OpenAPI Security Scanner 使用教程

openapi_security_scanner 项目地址: https://gitcode.com/gh_mirrors/op/openapi_security_scanner

1. 项目目录结构及介绍

openapi_security_scanner/
├── api.yaml
├── gitignore
├── gitlab-ci.yml
├── LICENSE
├── README.md
├── openapi_security_scanner.py
├── requirements.txt
└── schemathesis

• api.yaml: 目标API的OpenAPI描述文件。
• gitignore: Git忽略文件配置。
• gitlab-ci.yml: GitLab CI/CD配置文件。
• LICENSE: 项目许可证文件，采用Apache-2.0许可证。
• README.md: 项目说明文档。
• openapi_security_scanner.py: 项目的主启动文件。
• requirements.txt: 项目依赖的Python包列表。
• schemathesis: 项目使用的Schemathesis工具目录。

2. 项目启动文件介绍

openapi_security_scanner.py

这是项目的主启动文件，负责执行API的安全扫描任务。文件中包含了主要的逻辑代码，用于读取配置、生成测试用例、执行API调用并分析结果。

3. 项目配置文件介绍

api.yaml

api.yaml 是目标API的OpenAPI描述文件。在使用项目前，需要将目标API的OpenAPI描述文件内容替换到这个文件中。

gitlab-ci.yml

gitlab-ci.yml 是GitLab CI/CD的配置文件，定义了项目的CI/CD流程。通过这个文件，可以配置项目的自动化测试和部署流程。

requirements.txt

requirements.txt 列出了项目依赖的Python包。在使用项目前，需要通过以下命令安装这些依赖：

pip install -r requirements.txt

环境变量配置

在使用项目时，还需要配置一些环境变量，这些变量可以在GitLab项目设置中进行配置：

• OPENAPI_CREDS: 用于API调用的认证信息，格式为JSON。
• OPENAPI_ENDPOINTS: 需要测试的API端点，格式为JSON。
• OPENAPI_PATHS: API路径变量，格式为JSON。
• PRIVATE_TOKEN: GitLab API访问令牌。
• OPENAPI_BASE_URL: API服务器的基URL。

通过这些配置，项目可以自动生成测试用例并执行API安全扫描。

openapi_security_scanner 项目地址: https://gitcode.com/gh_mirrors/op/openapi_security_scanner