pop-api / api-rest
Create REST endpoints in the PoP API
Requires
- php: ^8.1
- pop-api/api-mirrorquery: ^6.0.2
Requires (Dev)
- phpstan/phpstan: ^1.8
- phpunit/phpunit: ^10.2
- rector/rector: ^0.18
- squizlabs/php_codesniffer: ^3.6
Conflicts
- gatographql/external-dependency-wrappers: <6.0.2
- gatographql/gatographql: <6.0.2
- gatographql/plugin-utils: <6.0.2
- gatographql/testing-schema: <6.0.2
- getpop/access-control: <6.0.2
- getpop/cache-control: <6.0.2
- getpop/component-model: <6.0.2
- getpop/componentrouting: <6.0.2
- getpop/definitions: <6.0.2
- getpop/dom-crawler: <6.0.2
- getpop/engine: <6.0.2
- getpop/engine-wp: <6.0.2
- getpop/engine-wp-bootloader: <6.0.2
- getpop/filestore: <6.0.2
- getpop/graphql-parser: <6.0.2
- getpop/guzzle-http: <6.0.2
- getpop/loosecontracts: <6.0.2
- getpop/mandatory-directives-by-configuration: <6.0.2
- getpop/markdown-convertor: <6.0.2
- getpop/root: <6.0.2
- getpop/root-wp: <6.0.2
- graphql-by-pop/graphiql: <6.0.2
- graphql-by-pop/graphql-clients-for-wp: <6.0.2
- graphql-by-pop/graphql-endpoint-for-wp: <6.0.2
- graphql-by-pop/graphql-request: <6.0.2
- graphql-by-pop/graphql-server: <6.0.2
- graphql-by-pop/graphql-voyager: <6.0.2
- phpunit-for-gatographql/dummy-schema: <6.0.2
- phpunit-for-gatographql/dummy-wp-schema: <6.0.2
- phpunit-for-gatographql/gatographql: <6.0.2
- phpunit-for-gatographql/gatographql-testing: <6.0.2
- phpunit-for-gatographql/webserver-requests: <6.0.2
- phpunit-for-gatographql/wpfaker-schema: <6.0.2
- pop-api/api: <6.0.2
- pop-api/api-clients: <6.0.2
- pop-api/api-endpoints: <6.0.2
- pop-api/api-endpoints-for-wp: <6.0.2
- pop-api/api-graphql: <6.0.2
- pop-backbone/php-hooks: <6.0.2
- pop-backbone/wp-data-parser: <6.0.2
- pop-cms-schema/categories: <6.0.2
- pop-cms-schema/categories-wp: <6.0.2
- pop-cms-schema/category-mutations: <6.0.2
- pop-cms-schema/category-mutations-wp: <6.0.2
- pop-cms-schema/comment-mutations: <6.0.2
- pop-cms-schema/comment-mutations-wp: <6.0.2
- pop-cms-schema/commentmeta: <6.0.2
- pop-cms-schema/commentmeta-wp: <6.0.2
- pop-cms-schema/comments: <6.0.2
- pop-cms-schema/comments-wp: <6.0.2
- pop-cms-schema/custompost-categories-wp: <6.0.2
- pop-cms-schema/custompost-category-mutations: <6.0.2
- pop-cms-schema/custompost-category-mutations-wp: <6.0.2
- pop-cms-schema/custompost-mutations: <6.0.2
- pop-cms-schema/custompost-mutations-wp: <6.0.2
- pop-cms-schema/custompost-tag-mutations: <6.0.2
- pop-cms-schema/custompost-tag-mutations-wp: <6.0.2
- pop-cms-schema/custompost-tags-wp: <6.0.2
- pop-cms-schema/custompost-user-mutations: <6.0.2
- pop-cms-schema/custompost-user-mutations-wp: <6.0.2
- pop-cms-schema/custompostmedia: <6.0.2
- pop-cms-schema/custompostmedia-mutations: <6.0.2
- pop-cms-schema/custompostmedia-mutations-wp: <6.0.2
- pop-cms-schema/custompostmedia-wp: <6.0.2
- pop-cms-schema/custompostmeta: <6.0.2
- pop-cms-schema/custompostmeta-wp: <6.0.2
- pop-cms-schema/customposts: <6.0.2
- pop-cms-schema/customposts-wp: <6.0.2
- pop-cms-schema/media: <6.0.2
- pop-cms-schema/media-mutations: <6.0.2
- pop-cms-schema/media-mutations-wp: <6.0.2
- pop-cms-schema/media-wp: <6.0.2
- pop-cms-schema/menus: <6.0.2
- pop-cms-schema/menus-wp: <6.0.2
- pop-cms-schema/meta: <6.0.2
- pop-cms-schema/metaquery-wp: <6.0.2
- pop-cms-schema/page-mutations: <6.0.2
- pop-cms-schema/page-mutations-wp: <6.0.2
- pop-cms-schema/pagemedia-mutations: <6.0.2
- pop-cms-schema/pages: <6.0.2
- pop-cms-schema/pages-wp: <6.0.2
- pop-cms-schema/post-categories: <6.0.2
- pop-cms-schema/post-categories-wp: <6.0.2
- pop-cms-schema/post-category-mutations: <6.0.2
- pop-cms-schema/post-mutations: <6.0.2
- pop-cms-schema/post-tag-mutations: <6.0.2
- pop-cms-schema/post-tags: <6.0.2
- pop-cms-schema/post-tags-wp: <6.0.2
- pop-cms-schema/postmedia-mutations: <6.0.2
- pop-cms-schema/posts: <6.0.2
- pop-cms-schema/posts-wp: <6.0.2
- pop-cms-schema/queriedobject: <6.0.2
- pop-cms-schema/queriedobject-wp: <6.0.2
- pop-cms-schema/schema-commons: <6.0.2
- pop-cms-schema/schema-commons-wp: <6.0.2
- pop-cms-schema/settings: <6.0.2
- pop-cms-schema/settings-wp: <6.0.2
- pop-cms-schema/tag-mutations: <6.0.2
- pop-cms-schema/tag-mutations-wp: <6.0.2
- pop-cms-schema/tags: <6.0.2
- pop-cms-schema/tags-wp: <6.0.2
- pop-cms-schema/taxonomies: <6.0.2
- pop-cms-schema/taxonomies-wp: <6.0.2
- pop-cms-schema/taxonomy-mutations: <6.0.2
- pop-cms-schema/taxonomy-mutations-wp: <6.0.2
- pop-cms-schema/taxonomymeta: <6.0.2
- pop-cms-schema/taxonomymeta-wp: <6.0.2
- pop-cms-schema/taxonomyquery: <6.0.2
- pop-cms-schema/taxonomyquery-wp: <6.0.2
- pop-cms-schema/user-avatars: <6.0.2
- pop-cms-schema/user-avatars-wp: <6.0.2
- pop-cms-schema/user-roles: <6.0.2
- pop-cms-schema/user-roles-wp: <6.0.2
- pop-cms-schema/user-state: <6.0.2
- pop-cms-schema/user-state-mutations: <6.0.2
- pop-cms-schema/user-state-mutations-wp: <6.0.2
- pop-cms-schema/user-state-wp: <6.0.2
- pop-cms-schema/usermeta: <6.0.2
- pop-cms-schema/usermeta-wp: <6.0.2
- pop-cms-schema/users: <6.0.2
- pop-cms-schema/users-wp: <6.0.2
- pop-schema/directive-commons: <6.0.2
- pop-schema/extended-schema-commons: <6.0.2
- pop-schema/http-requests: <6.0.2
- pop-schema/schema-commons: <6.0.2
- pop-wp-schema/block-content-parser: <6.0.2
- pop-wp-schema/blocks: <6.0.2
- pop-wp-schema/commentmeta: <6.0.2
- pop-wp-schema/comments: <6.0.2
- pop-wp-schema/custompostmeta: <6.0.2
- pop-wp-schema/customposts: <6.0.2
- pop-wp-schema/media: <6.0.2
- pop-wp-schema/menus: <6.0.2
- pop-wp-schema/meta: <6.0.2
- pop-wp-schema/multisite: <6.0.2
- pop-wp-schema/pages: <6.0.2
- pop-wp-schema/posts: <6.0.2
- pop-wp-schema/schema-commons: <6.0.2
- pop-wp-schema/settings: <6.0.2
- pop-wp-schema/site: <6.0.2
- pop-wp-schema/taxonomymeta: <6.0.2
- pop-wp-schema/usermeta: <6.0.2
- pop-wp-schema/users: <6.0.2
- dev-master / 6.1.x-dev
- 6.0.2
- 6.0.1
- 6.0.0
- 5.0.0
- 4.2.0
- 4.1.1
- 4.1.0
- 4.0.1
- 4.0.0
- 3.0.0
- 2.6.1
- 2.6.0
- 2.5.2
- 2.5.1
- 2.5.0
- 2.4.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1.3
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.1
- 1.6.0
- 1.5.5
- 1.5.4
- 1.5.3
- 1.5.2
- 1.5.1
- 1.5.0
- 1.4.0
- 1.3.1
- 1.3.0
- 1.2.0
- 1.1.1
- 1.1.0
- 1.0.15
- 1.0.14
- 1.0.13
- 1.0.12
- 1.0.11
- 1.0.10
- 1.0.9
- 1.0.8
- 1.0.7
- 1.0.6
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- 0.10.2
- 0.10.1
- 0.10.0
- 0.9.10
- 0.9.9
- 0.9.8
- 0.9.7
- 0.9.6
- 0.9.5
- 0.9.4
- 0.9.3
- 0.9.2
- 0.9.1
- 0.9.0
- 0.8.9
- 0.8.8
- 0.8.7
- 0.8.6
- 0.8.5
- 0.8.4
- v0.8.3
- v0.8.2
- 0.8.1
- 0.7.13
- 0.7.12
- 0.7.11
- 0.7.10
- 0.7.9
- 0.7.8
- 0.7.7
- 0.7.6
This package is auto-updated.
Last update: 2024-10-11 12:56:38 UTC
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.2+ for production
Supported PHP features
Check the list of Supported PHP features in GatoGraphQL/GatoGraphQL
Preview downgrade to PHP 7.2
Via Rector (dry-run mode):
composer preview-code-downgrade
Standards
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.