PHPackages                             widmogrod/zf2-rest-api-documentator - 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. widmogrod/zf2-rest-api-documentator

ActiveLibrary

widmogrod/zf2-rest-api-documentator
===================================

Module generating REST API documentation

1.6.3(12y ago)167.7k↓100%3[1 issues](https://github.com/widmogrod/zf2-rest-api-documentator/issues)MITPHPPHP >=5.3

Since Apr 14Pushed 12y ago1 watchersCompare

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

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

Module generating REST API documentation v1.6.1 [![Build Status](https://camo.githubusercontent.com/1c25aaf3b5b74051e15548243128728154077cfc23058eb56c36ea8325b4c1eb/68747470733a2f2f7472617669732d63692e6f72672f7769646d6f67726f642f7a66322d726573742d6170692d646f63756d656e7461746f722e706e673f6272616e63683d6d6173746572)](https://travis-ci.org/widmogrod/zf2-rest-api-documentator)
========================================================================================================================================================================================================================================================================================================================================================================================

[](#module-generating-rest-api-documentation-v161-)

Introduction
------------

[](#introduction)

This module allow to create quick documentation of your REST API.

Main features that I want to implement:

- Generate REST API documentation.
    - `[√]` Describe function of available parameters
    - `[√]` Create a general description of the parameters several times repeated
- Unlimited number of documented APIs
    - `[√]` Create modules for ZF2 containing a good and standardized documentation
- Elastic & simple to use.
    - `[√]` Use predefined interpreter for configuration or write it by your self
    - `[-]` Do you have a self-describing API and you want to automaticly build documentation from it? Help me, to write that kind of interpreter or wait until I'll do it
- Well documented
    - `[√]` The module is shipped with API documentation, documented by this module.
    - `[√]` Some issues are described in tips & trick section
- Posibility to test & play with API from docs page
    - `[√]` Execute API call from documentation
    - `[-]` Performing authorization (OAuth, BaseAuth, ...)

Read [TODO.md](https://github.com/widmogrod/zf2-rest-api-documentator/blob/master/TODO.md) for more information.

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

[](#installation)

1. `cd my/project/directory`
2. Create a `composer.json` file with following content:

```
{
    "require": {
        "widmogrod/zf2-rest-api-documentator": "1.*"
    }
}
```

3. Run `php composer.phar install`
4. Open `my/project/folder/configs/application.config.php` and: - add `'WidRestApiDocumentator'` to your `'modules'` parameter. - add `'AsseticBundle'` to your `'modules'` parameter (optional if you want to include CSS)

Usage
-----

[](#usage)

Bellow is php configuration file that show haw to implement simple REST API documentation in your module. This is a minimal configuration required to achieve result shown further dawn.

```