PHPackages                             getpop/api-rest - 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. [HTTP & Networking](/categories/http)
4. /
5. getpop/api-rest

ActiveLibrary[HTTP & Networking](/categories/http)

getpop/api-rest
===============

Create REST endpoints in the PoP API

17.1.1(1mo ago)28121GPL-2.0-or-laterPHPPHP ^8.1

Since Jan 25Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/PoP-PoPAPI/api-rest)[ Packagist](https://packagist.org/packages/getpop/api-rest)[ Docs](https://github.com/PoP-PoPAPI/api-rest)[ RSS](/packages/getpop-api-rest/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (5)Versions (151)Used By (1)

REST API
========

[](#rest-api)

It enables to add REST endpoints to retrieve data for any URL-based resource. It is based on the [PoP API](https://github.com/PoP-PoPAPI/api) package.

Install
-------

[](#install)

Via Composer

```
composer require pop-api/api-rest
```

Development
-----------

[](#development)

The source code is hosted on the [GatoGraphQL monorepo](https://github.com/GatoGraphQL/GatoGraphQL), under [`API/packages/api-rest`](https://github.com/GatoGraphQL/GatoGraphQL/tree/master/layers/API/packages/api-rest).

### Enable pretty permalinks

[](#enable-pretty-permalinks)

#### Apache

[](#apache)

Make sure the Apache server has modules [`proxy`](https://httpd.apache.org/docs/current/mod/mod_proxy.html) and [`proxy_http`](https://httpd.apache.org/docs/current/mod/mod_proxy_http.html) installed and enabled. This enables configuration `"P"` in `"[L,P,QSA]"` from the rewrite rule below.

Add the following code in the `.htaccess` to support API endpoint `/api/rest/` at the end of the resource page URL:

```

RewriteEngine On
RewriteBase /

# Rewrite from /some-url/api/rest/ to /some-url/?scheme=api&datastructure=rest
RewriteCond %{SCRIPT_FILENAME} !-d
RewriteCond %{SCRIPT_FILENAME} !-f
RewriteRule ^(.*)/api/rest/?$ /$1/?scheme=api&datastructure=rest [L,P,QSA]

```

#### Nginx

[](#nginx)

Add the following code in the Nginx configuration's `server` entry, to enable API endpoint `/api/rest/`. Please notice that the resolver below is the one for Docker; replace this value for your environment.

```
location ~ ^(.*)/api/rest/?$ {
    # Resolver for Docker. Change to your own
    resolver 127.0.0.11 [::1];
    # If adding $args and it's empty, it does a redirect.
    # Then, add $args only if not empty
    set $redirect_uri "$scheme://$server_name$1/?scheme=api&datastructure=rest";
    if ($args) {
        set $redirect_uri "$scheme://$server_name$1/?$args&scheme=api&datastructure=rest";
    }
    proxy_pass $redirect_uri;
}
```

Usage
-----

[](#usage)

Initialize the component:

```
\PoP\Root\App::stockAndInitializeModuleClasses([([
    \PoPAPI\RESTAPI\Module::class,
]);
```

Append `/api/rest/` to the URL to fetch the pre-defined fields.

Standards
---------

[](#standards)

[PSR-1](https://www.php-fig.org/psr/psr-1), [PSR-4](https://www.php-fig.org/psr/psr-4) and [PSR-12](https://www.php-fig.org/psr/psr-12).

To check the coding standards via [PHP CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer), run:

```
composer check-style
```

To automatically fix issues, run:

```
composer fix-style
```

Change log
----------

[](#change-log)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Testing
-------

[](#testing)

To execute [PHPUnit](https://phpunit.de/), run:

```
composer test
```

Static Analysis
---------------

[](#static-analysis)

To execute [PHPStan](https://github.com/phpstan/phpstan), run:

```
composer analyse
```

Report issues
-------------

[](#report-issues)

To report a bug or request a new feature please do it on the [GatoGraphQL monorepo issue tracker](https://github.com/GatoGraphQL/GatoGraphQL/issues).

Contributing
------------

[](#contributing)

We welcome contributions for this package on the [GatoGraphQL monorepo](https://github.com/GatoGraphQL/GatoGraphQL) (where the source code for this package is hosted).

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE\_OF\_CONDUCT](CODE_OF_CONDUCT.md) for details.

Security
--------

[](#security)

If you discover any security related issues, please email  instead of using the issue tracker.

Credits
-------

[](#credits)

- [Leonardo Losoviz](https://github.com/leoloso)
- [All Contributors](../../../../../../contributors)

License
-------

[](#license)

GNU General Public License v2 (or later). Please see [License File](LICENSE.md) for more information.

###  Health Score

55

—

FairBetter than 97% of packages

Maintenance98

Actively maintained with recent releases

Popularity16

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity80

Battle-tested with a long release history

 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 ~12 days

Total

150

Last Release

46d ago

Major Versions

12.2.2 → 13.0.02025-05-23

13.2.0 → 14.0.02025-09-09

14.0.4 → 15.0.02025-09-23

15.3.0 → 16.0.02026-01-12

16.1.0 → 17.0.02026-03-03

PHP version history (3 changes)0.7.6PHP ^7.4|^8.0

0.8.1PHP ^8.0

0.9.0PHP ^8.1

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1981996?v=4)[Leonardo Losoviz](/maintainers/leoloso)[@leoloso](https://github.com/leoloso)

![](https://www.gravatar.com/avatar/d5a0a064bae63a335ddd796bb69ab38e1d01420d14bfcc8e3d4e1550922ac60b?d=identicon)[getpop](/maintainers/getpop)

---

Top Contributors

[![leoloso](https://avatars.githubusercontent.com/u/1981996?v=4)](https://github.com/leoloso "leoloso (611 commits)")

---

Tags

apiphppoprestphpapirestgraphqlapi-restGatoGatoGraphQL

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan, Rector

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/getpop-api-rest/health.svg)

```
[![Health](https://phpackages.com/badges/getpop-api-rest/health.svg)](https://phpackages.com/packages/getpop-api-rest)
```

###  Alternatives

[api-platform/laravel

API Platform support for Laravel

59126.4k5](/packages/api-platform-laravel)

PHPackages © 2026

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