Schemathesis 开源项目使用教程

Schemathesis 开源项目使用教程

schemathesisAutomate your API Testing: catch crashes, validate specs, and save time项目地址:https://gitcode.com/gh_mirrors/sc/schemathesis

1. 项目的目录结构及介绍

Schemathesis 项目的目录结构如下：

schemathesis/
├── .github/
│   └── workflows/
├── docs/
├── examples/
├── src/
│   └── schemathesis/
│       ├── cli/
│       ├── checks/
│       ├── constants.py
│       ├── exceptions.py
│       ├── models.py
│       ├── runner.py
│       ├── schemas.py
│       ├── serializers.py
│       ├── utils.py
│       └── __init__.py
├── tests/
├── .gitignore
├── LICENSE
├── README.md
├── pyproject.toml
└── setup.py

目录介绍

• .github/: 包含 GitHub 工作流配置文件。
• docs/: 包含项目文档。
• examples/: 包含示例代码。
• src/schemathesis/: 包含项目的主要源代码。
  • cli/: 命令行接口相关代码。
  • checks/: 检查逻辑相关代码。
  • constants.py: 常量定义。
  • exceptions.py: 异常定义。
  • models.py: 数据模型定义。
  • runner.py: 运行逻辑。
  • schemas.py: 模式定义。
  • serializers.py: 序列化逻辑。
  • utils.py: 工具函数。
  • __init__.py: 模块初始化文件。
• tests/: 包含测试代码。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证。
• README.md: 项目介绍文档。
• pyproject.toml: 项目配置文件。
• setup.py: 安装脚本。

2. 项目的启动文件介绍

Schemathesis 项目的启动文件是 src/schemathesis/__main__.py。这个文件负责启动命令行接口，处理用户输入的命令并调用相应的功能模块。

3. 项目的配置文件介绍

Schemathesis 项目的主要配置文件是 pyproject.toml。这个文件使用 TOML 格式，包含了项目的依赖、构建系统和一些基本配置信息。

pyproject.toml 示例

[tool.poetry]
name = "schemathesis"
version = "3.0.0"
description = "A tool for testing your web applications built with Open API / Swagger specifications."
authors = ["Author Name <author@example.com>"]
license = "MIT"

[tool.poetry.dependencies]
python = "^3.6"
requests = "^2.25.1"
hypothesis = "^6.14.0"

[tool.poetry.dev-dependencies]
pytest = "^6.2.2"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

配置文件介绍

• [tool.poetry]: 项目的基本信息，如名称、版本、描述、作者和许可证。
• [tool.poetry.dependencies]: 项目的依赖包及其版本要求。
• [tool.poetry.dev-dependencies]: 开发环境下的依赖包。
• [build-system]: 构建系统的要求和后端。

通过这些配置文件，用户可以了解项目的依赖关系和构建要求，从而更好地进行开发和测试。

schemathesisAutomate your API Testing: catch crashes, validate specs, and save time项目地址:https://gitcode.com/gh_mirrors/sc/schemathesis