Download the PHP package nglasl/silverstripe-apiwesome without Composer

On this page you can find all versions of the php package nglasl/silverstripe-apiwesome. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of nglasl/silverstripe-apiwesome

Informations about the package silverstripe-apiwesome

apiwesome

The current release is 2.2.15

A module for SilverStripe which will automatically create customisable JSON/XML feeds for your data objects (including pages), and provides a modular security token that can be used for other applications.

Requirement

This module is no longer supported.

Getting Started

Overview

Data Object Exclusions/Inclusions

ALL data objects are included by default (excluding some core), unless disabled or inclusions have explicitly been defined.

To completely disable the JSON/XML:

Attribute Visibility Customisation

visibility

The JSON/XML feed will only be available to data objects with attribute visibility set through the CMS. Any has_one relationships may be displayed, where attribute visibility is determined recursively.

Recursive Relationships

These are enabled by default, however will greatly impact performance if many nested relationships are visible.

To disable the recursion:

Security Token

A JSON/XML feed request will require the current security token passed through, where this may be regenerated by an administrator (invalidating the previous security token).

token

The security token generation (and validation) is modular, and can still be used when the JSON/XML is completely disabled (more below):

Output

A JSON/XML feed request may have a number of optional filters applied, where the &filter will only apply to visible attributes:

It may also be previewed through the appropriate model admin of your data object.

preview

Pretty JSON

This is enabled by default, however will slightly impact performance if many nested relationships are visible.

To disable the pretty printing:

Developer Functionality

PHP

Accessing the service:

The methods available may be programmatically called to generate JSON, with optional filters:

XML, with optional filters:

JSON/XML for a versioned page (though the CMS may not correctly preview XML), with regard to the respective stage in index():

They may also be used to parse JSON/XML from another APIwesome instance. Therefore, this module may be used as both an API and external connector between multiple projects.

The security token validation (and generation) is modular, and can be used for other applications (more above):

jQuery

JSON example:

Maintainer Contact

Nathan Glasl, [email protected]

All versions of silverstripe-apiwesome with dependencies

PHP Build Version
Package Version
Requires silverstripe/cms Version ~3.2
silverstripe/framework Version ~3.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package nglasl/silverstripe-apiwesome contains the following files

Loading the files please wait ....