PHPackages                             talkrz/rest-spec - 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. [API Development](/categories/api)
4. /
5. talkrz/rest-spec

ActiveLibrary[API Development](/categories/api)

talkrz/rest-spec
================

A small library for describing and testing REST APIs in PHP

027PHP

Since Sep 29Pushed 8y ago1 watchersCompare

[ Source](https://github.com/talkrz/rest-spec)[ Packagist](https://packagist.org/packages/talkrz/rest-spec)[ RSS](/packages/talkrz-rest-spec/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

[![Build Status](https://camo.githubusercontent.com/0b9aaa3d2ce9115082a43f800fcae1a51b7d1c32bf6183c3868b0ca9d6c76d96/68747470733a2f2f7472617669732d63692e6f72672f74616c6b727a2f726573742d737065632e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/talkrz/rest-spec)

rest-spec
=========

[](#rest-spec)

A simple library for creating self-verifying API specifications, and end-to-end testing written in PHP.

I do not recommend to use in on production yet, however will be happy if you will.

Installation
============

[](#installation)

You can install rest-spec by Composer.

Add package to your project's `composer.json` file:

```
{
    "require-dev": {
        "talkrz/rest-spec": "dev-master"
    }
}
```

Install it with Composer:

```
composer install
```

Usage
=====

[](#usage)

Basic example: describing GitHub API
------------------------------------

[](#basic-example-describing-github-api)

Create `rest-spec` directory in your project's root.

Create `github.php` file (you can choose any file name) inside it with an API specification:

```