PHPackages                             restful-template/response-template - 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. restful-template/response-template

ActiveLibrary[API Development](/categories/api)

restful-template/response-template
==================================

A response interface builder for REST API

1.0.2(1y ago)031GPL-3.0-or-laterPHPPHP ^8.2

Since Nov 4Pushed 1y ago1 watchersCompare

[ Source](https://github.com/enriquerene/response-template)[ Packagist](https://packagist.org/packages/restful-template/response-template)[ Docs](https://github.com/enriquerene/response-template.git)[ RSS](/packages/restful-template-response-template/feed)WikiDiscussions main Synced 5d ago

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

Response Template
=================

[](#response-template)

A response interface builder for REST API.

Table of Contents
-----------------

[](#table-of-contents)

- [Installation](#installation)
- [Usage](#usage)
    - [Simples Case](#simplest-case)
    - [Data in Response](#data-in-response)
    - [Links Setup](#links-setup)
- [Plan](#plan)
- [Support](#support)
- [Contribute](#contribute)

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

[](#-installation)

There are some installation ways. You can choose the best way for you.

### Composer (recommended)

[](#composer-recommended)

This way requires [Composer](https://getcomposer.org):

```
$ composer require restful-template/response-template
```

### Git

[](#git)

Clone the repo into your project:

```
$ git clone https://github.com/enriquerene/response-template.git
```

### Zip

[](#zip)

Dowload the package and uncpack it into your project: [Dowload ZIP](https://github.com/enriquerene/response-template/archive/main.zip)

 Usage
---------------------------------------

[](#-usage)

ResponseTemplate requires an valid HTTP Status Code. Refer to [section 10 of RFC 2616](https://tools.ietf.org/html/rfc2616#section-10).

###  Simplest Case

[](#-simplest-case)

The simplest case is to instantiate the class ResponseTemplate with HTTP Status Code "200 Ok." and call method `build`:

```