PHPackages                             tecnocen/codeception-api-skeleton - 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 &amp; Quality](/categories/testing)
4. /
5. tecnocen/codeception-api-skeleton

ActiveProject[Testing &amp; Quality](/categories/testing)

tecnocen/codeception-api-skeleton
=================================

Codeception template to create automated tests on external APIs

0222PHP

Since Mar 7Pushed 8y ago2 watchersCompare

[ Source](https://github.com/tecnocen-com/codeception-api-skeleton)[ Packagist](https://packagist.org/packages/tecnocen/codeception-api-skeleton)[ RSS](/packages/tecnocen-codeception-api-skeleton/feed)WikiDiscussions master Synced 4d ago

READMEChangelogDependenciesVersions (1)Used By (0)

Codeception Api Skeleton
========================

[](#codeception-api-skeleton)

Skeleton to create codeception tests using for external projects using suites

- functional
- api
- acceptance

Requirements
------------

[](#requirements)

- Php &gt;=7.0
- Composer &gt;=1.3
- Java JDK able to run selenium web drivers [Official Documentation](http://www.seleniumhq.org/docs/03_webdriver.jsp#php)

Installation
------------

[](#installation)

The preferred way to install is through [composer](https://getcomposer.org/download/).

`composer create-project --prefer-dist tecnocen/codeception-api-skeleton codeception-tests`

The command installs the advanced application in a directory named `codeception-tests`. You can choose a different directory name if you want.

If you cloned the project using a CVS like git then run

`composer install --prefer-dist`

on the root project before continuing preparations.

Preparing application
---------------------

[](#preparing-application)

### `composer deploy`

[](#composer-deploy)

This library provides a console command to help initialize the application.

`composer deploy -- os=win32 gecko=0.18.0 chrome=2.32 selenium=3.6.0`

It accepts parameters

- os: the Operative system version which will run the selenium web driver. By default it will be auto determined by php.
- selenium: the version for selenium standalone jar file.
- gecko: the version of [Gecko Driver](https://github.com/mozilla/geckodriver/) to be used.
- chrome: the version of [Chrome Driver](https://sites.google.com/a/chromium.org/chromedriver/) to be used.

This will install the php dependencies using composer and download [selenium](http://www.seleniumhq.org/download/)standalone and the supported webdrivers in the files `selenium-ss.jar`,

`geckodriver` and `chromedriver`

### Edit your configuration files

[](#edit-your-configuration-files)

Configure [codeception](http://codeception.com/) to use your project url.

- `tests/functional.suite.yml` configuration `PhpBrowser.url`
- `tests/api.suite.yml` configuration `Rest.url`
- `tests/acceptance.suite.yml` configuration `WebDriver.url`

### Initialize web drivers

[](#initialize-web-drivers)

This library also provides commands to easily initialize the selenium web drivers

- `composer init-chromedriver` to run the tests on chrome or chromium browser.
- `composer init-geckodriver` to run the tests on firefox.

Run Tests
---------

[](#run-tests)

You can run tests by using the following composer scripts.

- `composer run-functional-tests` run functional tests. (selenium not required)
- `composer run-api-tests` run REST api tests. (selenium not required)
- `composer run-acceptance-tests` run acceptance tests. (selenium required)
- `composer run-tests` **all supported tests**

Write tests
-----------

[](#write-tests)

This skeleton uses [codeception](http://codeception.com/) so direct to that guide on how to write tests for each suite.

Unit tests and Code Coverage
----------------------------

[](#unit-tests-and-code-coverage)

Since this is an standalone library meant to work without access to the api source code its not possible to create unit tests or review test coverage.

###  Health Score

21

—

LowBetter than 19% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity41

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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/2341d88f3cdea0c2474cfbf59e5cf6dab5dd6a026d7846fabf219f2a93be1641?d=identicon)[neverabe](/maintainers/neverabe)

---

Top Contributors

[![Faryshta](https://avatars.githubusercontent.com/u/2029247?v=4)](https://github.com/Faryshta "Faryshta (14 commits)")

### Embed Badge

![Health badge](/badges/tecnocen-codeception-api-skeleton/health.svg)

```
[![Health](https://phpackages.com/badges/tecnocen-codeception-api-skeleton/health.svg)](https://phpackages.com/packages/tecnocen-codeception-api-skeleton)
```

###  Alternatives

[phpspec/prophecy

Highly opinionated mocking framework for PHP 5.3+

8.5k551.7M682](/packages/phpspec-prophecy)[vimeo/psalm

A static analysis tool for finding errors in PHP applications

5.8k77.5M6.7k](/packages/vimeo-psalm)[brianium/paratest

Parallel testing for PHP

2.5k118.8M754](/packages/brianium-paratest)[beberlei/assert

Thin assertion library for input validation in business models.

2.4k96.9M570](/packages/beberlei-assert)[mikey179/vfsstream

Virtual file system to mock the real file system in unit tests.

1.4k108.0M2.7k](/packages/mikey179-vfsstream)[orchestra/testbench

Laravel Testing Helper for Packages Development

2.2k39.1M32.1k](/packages/orchestra-testbench)

PHPackages © 2026

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