Download the PHP package pop-api/api without Composer
On this page you can find all versions of the php package pop-api/api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package api
Short Description Component-based API
License GPL-2.0-or-later
Homepage https://github.com/PoP-PoPAPI/api
Informations about the package api
PoP API
Convert the application into a powerful API. Install the Gato GraphQL 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
Enable pretty permalinks
Apache
Add the following code in the .htaccess
file to enable API endpoint /api/
:
To add pretty API endpoints for the extensions (GraphQL => /api/graphql/
), REST => /api/rest/
), add the following code to file .htaccess
:
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.
To add pretty API endpoints for the extensions (GraphQL => /api/graphql/
), REST => /api/rest/
), add the following code:
Development
The source code is hosted on the GatoGraphQL monorepo, under API/packages/api
.
Usage
Initialize the component:
Note:
To enable GraphQL and/or REST endpoints, the corresponding package must be installed: GraphQL package, REST package
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):
Standards
To check the coding standards via PHP CodeSniffer, run:
To automatically fix issues, run:
Change log
Please see CHANGELOG for more information on what has changed recently.
Testing
To execute PHPUnit, run:
Static Analysis
To execute PHPStan, run:
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 CODE_OF_CONDUCT for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Leonardo Losoviz
- All Contributors
License
GNU General Public License v2 (or later). Please see License File for more information.