Download the PHP package aternos/poggit-api without Composer
On this page you can find all versions of the php package aternos/poggit-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download aternos/poggit-api
More information about aternos/poggit-api
Files in aternos/poggit-api
Package poggit-api
Short Description PHP Client for the Poggit API. This client is based on openapi.
License MIT
Homepage https://github.com/aternosorg/php-poggit-api
Informations about the package poggit-api
Aternos/php-poggit-client
An API client for the Poggit API written in PHP. This client is a combination of code generated by OpenAPI Generator and some wrappers around it to improve the usability.
The generated code can be found in src/Api
and src/Model
. It is recommended
to use the Wrappers in src/Client
instead of the generated code.
Installation
Install the package via composer:
Usage
The main entry point for the API is the PoggitAPIClient
class.
Releases
The Poggit API does not seperate projects and versions. It only provides Release
objects which contain data about a project and a specific version. You can get a
list of releases for a project with the getReleases()
method.
Pagination is not supported by the Poggit API. The getReleases()
method will return
a list of all releases of all plugins by default.
Searching for Releases with options
You can filter the releases using search options:
Get a specific release by ID
You can get a specific release by its ID:
Get the latest release of a plugin by name
You can get the latest release of a plugin by its name:
Download a release
You can download a release by the project name and version:
[!NOTE] This method downloads the release to a new file in the current working directory. There is no option to specify a download location. Using the artifact URL from a release and downloading it with a HTTP client is recommended for more control over the download process.
Get hashes of a release
You can get the hashes of a release by the project name and version:
Updating the generated code
The generated code can be updated by installing the openapi generator and running the following command:
All versions of poggit-api with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.4.5
guzzlehttp/psr7 Version ^2.0