getpop/api

Component-based API

Maintainers

Details

github.com/getpop/api

Homepage

Source

Installs: 5 777

Dependents: 21

Suggesters: 17

Security: 0

Stars: 2

Watchers: 3

Forks: 0

0.8.8 2021-09-27 06:44 UTC

This package is auto-updated.

Last update: 2021-10-27 09:00:30 UTC


README

Convert the application into a powerful API. Install the GraphQL API package to convert it into a GraphQL server, and the REST API package to enable adding REST endpoints.

Install

Installing a fully-working API:

Follow the instructions under Bootstrap a PoP API for WordPress (even though CMS-agnostic, only the WordPress adapters have been presently implemented).

Installing this library:

Via Composer

composer require getpop/api

Enable pretty permalinks

Apache

Add the following code in the .htaccess file to enable API endpoint /api/:

<IfModule mod_rewrite.c>
RewriteEngine On
RewriteBase /

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

# Rewrite from api/ to /?scheme=api
RewriteCond %{SCRIPT_FILENAME} !-d
RewriteCond %{SCRIPT_FILENAME} !-f
RewriteRule ^api/?$ /?scheme=api [L,P,QSA]
</IfModule>

To add pretty API endpoints for the extensions (GraphQL => /api/graphql/), REST => /api/rest/), add the following code to file .htaccess:

<IfModule mod_rewrite.c>
RewriteEngine On
RewriteBase /

# a. Resource endpoints
# 1 and 2. GraphQL or REST: Rewrite from /some-url/api/(graphql|rest)/ to /some-url/?scheme=api&datastructure=(graphql|rest)
RewriteCond %{SCRIPT_FILENAME} !-d
RewriteCond %{SCRIPT_FILENAME} !-f
RewriteRule ^(.*)/api/(graphql|rest)/?$ /$1/?scheme=api&datastructure=$2 [L,P,QSA]

# b. Homepage single endpoint (root)
# 1 and 2. GraphQL or REST: Rewrite from api/(graphql|rest)/ to /?scheme=api&datastructure=(graphql|rest)
RewriteCond %{SCRIPT_FILENAME} !-d
RewriteCond %{SCRIPT_FILENAME} !-f
RewriteRule ^api/(graphql|rest)/?$ /?scheme=api&datastructure=$1 [L,P,QSA]
</IfModule>
Nginx

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

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

To add pretty API endpoints for the extensions (GraphQL => /api/graphql/), REST => /api/rest/), add the following code:

location ~ ^(.*)/api/(rest|graphql)/?$ {
    # Resolver for Docker. Change to your own
    resolver 127.0.0.11 [::1];
    set $redirect_uri "$scheme://$server_name$1/?scheme=api&datastructure=$2";
    if ($args) {
        set $redirect_uri "$scheme://$server_name$1/?$args&scheme=api&datastructure=$2";
    }
    proxy_pass $redirect_uri;
}

Development

The source code is hosted on the PoP monorepo, under API/packages/api.

Usage

Initialize the component:

\PoP\Root\AppLoader::addComponentClassesToInitialize([
    \PoP\API\Component::class,
]);

Note:
To enable GraphQL and/or REST endpoints, the corresponding package must be installed: GraphQL package, REST package

  1. Transform any URL into an API endpoint by adding:

    .../api/ (PoP native format)
    .../api/graphql/ (GraphQL)
    .../api/rest/ (REST)

  2. Add your query under URL parameter query, following this syntax

PHP versions

Requirements:

  • PHP 8.0+ for development
  • PHP 7.1+ for production

Supported PHP features

Check the list of Supported PHP features in leoloso/PoP

Preview downgrade to PHP 7.1

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 PoP monorepo issue tracker.

Contributing

We welcome contributions for this package on the PoP 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.