README

It enables to add REST endpoints to retrieve data for any URL-based resource. It is based on the PoP API package.

Install

Via Composer

composer require pop-api/api-rest

Development

The source code is hosted on the GatoGraphQL monorepo, under API/packages/api-rest.

Enable pretty permalinks

Apache

Make sure the Apache server has modules proxy and proxy_http 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:

<IfModule mod_rewrite.c>
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]
</IfModule>

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

Initialize the component:

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

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

PHP versions

Requirements:

PHP 8.1+ for development
PHP 7.4+ for production

Supported PHP features

Check the list of Supported PHP features in GatoGraphQL/GatoGraphQL

Preview downgrade to PHP 7.4

Via Rector (dry-run mode):

composer preview-code-downgrade

Standards

PSR-1, PSR-4 and PSR-12.

To check the coding standards via PHP CodeSniffer, run:

composer check-style

To automatically fix issues, run:

composer fix-style

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

To execute PHPUnit, run:

composer test

Static Analysis

To execute PHPStan, run:

composer analyse

Report issues

To report a bug or request a new feature please do it on the GatoGraphQL monorepo issue tracker.

Contributing

We welcome contributions for this package on the GatoGraphQL monorepo (where the source code for this package is hosted).

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

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

Credits

License

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

pop-api / api-rest

Maintainers

Details