PHPackages                             mikelgoig/codeception-openapi - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Testing & Quality](/categories/testing)
4. /
5. mikelgoig/codeception-openapi

ActiveLibrary[Testing & Quality](/categories/testing)

mikelgoig/codeception-openapi
=============================

Codeception module for contract testing with OpenAPI.

2.2.1(1y ago)124MITPHPPHP 8.3.\*

Since Jan 9Pushed 1y ago1 watchersCompare

[ Source](https://github.com/mikelgoig/codeception-openapi)[ Packagist](https://packagist.org/packages/mikelgoig/codeception-openapi)[ RSS](/packages/mikelgoig-codeception-openapi/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (19)Versions (9)Used By (0)

 Codeception Module for contract testing with OpenAPI
======================================================

[](#----codeception-module-for-contract-testing-with-openapi)

Created by [Mikel Goig](https://mikelgoig.com).

 [ View Repository ](https://github.com/mikelgoig/codeception-openapi)

---

[![Packagist Version](https://camo.githubusercontent.com/11716aa4af2659d717f2c1313994118cbb5a8d42cfaf642162a3aaeafd7d1d13/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d696b656c676f69672f636f646563657074696f6e2d6f70656e617069)](https://packagist.org/packages/mikelgoig/codeception-openapi)[![Packagist Downloads](https://camo.githubusercontent.com/f3f9cd05b938f7775e15a0265f0bbb816d279a45cc780d34a718c6bb6850694a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6d696b656c676f69672f636f646563657074696f6e2d6f70656e617069)](https://packagist.org/packages/mikelgoig/codeception-openapi/stats)[![Packagist PHP Version](https://camo.githubusercontent.com/6f8728674c74cdc5f0d0007559649c821d3369618f078a047d92cd4dea94d39a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f6d696b656c676f69672f636f646563657074696f6e2d6f70656e6170692f706870)](https://thephp.foundation)

**This Codeception module provides you with actions to validate API requests and responses with an [OpenAPI](https://openapis.org) Specification.**

It requires [REST](https://codeception.com/docs/modules/REST)and [Symfony](https://codeception.com/docs/modules/Symfony) modules.

It supports [Gherkin format](https://codeception.com/docs/BDD).

😎 Installation
--------------

[](#-installation)

1. Install this package using Composer:

    ```
    composer require --dev mikelgoig/codeception-openapi
    ```

🛠️ Configuration
----------------

[](#️-configuration)

1. Add the Codeception module to your config file:

    ```
    modules:
      enabled:
        - MikelGoig\Codeception\Module\OpenApi:
            depends: [ REST, Symfony ]
            openapi: path/to/openapi.yaml
            multipart_boundary: foo
    ```

    - `openapi` - the path of the OpenAPI file
    - `multipart_boundary` *optional* - the boundary parameter for multipart requests
2. To set up Gherkin steps, enable the `gherkin` part of the module:

    ```
    modules:
      enabled:
        - MikelGoig\Codeception\Module\OpenApi:
            # ...
            part: gherkin
    ```

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance41

Moderate activity, may be stable

Popularity8

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

8

Last Release

485d ago

Major Versions

1.0.2 → 2.0.02025-01-15

### Community

Maintainers

![](https://www.gravatar.com/avatar/747d9f689737779231e5602355fdcbf154f9b773eff7b0823a59fb9a57a3bfef?d=identicon)[mikelgoig](/maintainers/mikelgoig)

---

Top Contributors

[![mikelgoig](https://avatars.githubusercontent.com/u/8067861?v=4)](https://github.com/mikelgoig "mikelgoig (23 commits)")

---

Tags

codeceptioncontract-testingdevgherkinopenapirestsymfonytestingtestingsymfonydevrestcodeceptionopenapigherkincontract-testing

###  Code Quality

Static AnalysisPHPStan

Code StyleECS

Type Coverage Yes

### Embed Badge

![Health badge](/badges/mikelgoig-codeception-openapi/health.svg)

```
[![Health](https://phpackages.com/badges/mikelgoig-codeception-openapi/health.svg)](https://phpackages.com/packages/mikelgoig-codeception-openapi)
```

###  Alternatives

[api-platform/core

Build a fully-featured hypermedia or GraphQL API in minutes!

2.6k48.1M236](/packages/api-platform-core)[symfony/panther

A browser testing and web scraping library for PHP and Symfony.

3.1k14.7M96](/packages/symfony-panther)[osteel/openapi-httpfoundation-testing

Validate HttpFoundation requests and responses against OpenAPI (3+) definitions

1201.9M6](/packages/osteel-openapi-httpfoundation-testing)[happyr/service-mocking

Make it easy to mock services in a built container

48253.8k2](/packages/happyr-service-mocking)[pierstoval/smoke-testing

Smoke testing automator for Symfony applications

4032.6k](/packages/pierstoval-smoke-testing)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)