PHP download

Download the PHP package radic/graphql_streams_api-module without Composer

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

Table of contents
Download radic/graphql_streams_api-module
More information about radic/graphql_streams_api-module
Files in radic/graphql_streams_api-module

Vendor radic
Package graphql_streams_api-module
Short Description Effortlessly bind your PyroCMS Streams to the GraphQL API service. A great alternative to the non-free pro api-module addon.
License MIT
Homepage https://github.com/robinradic/graphql-streams-api

Keywords rest api Streams restfull pyrocms graphql

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 radic/graphql_streams_api-module

Informations about the package graphql_streams_api-module

PyroCMS GraphQL Streams Api Module

Introduction
Preview
Documentation
- Installation
- Customization
- Generate
License

Introduction

This module aims to provide an easy yet flexiable way to bind your PyroCMS Streams to a GraphQL API. This module integrates nuwave/lighthouse with PyroCMS Streams.

Please make sure you have a basic understanding of:

Preview

A small usage preview of this module.

1. Configure the bindings

config.php

2. Generate the schema.graphql

When you have defined all stream bindings and resolutions to your liking then you need to run the generator. This will generate a GraphQL schema definition file that will be used by Lighthouse:

3. And voila!

GraphQL Query and Result

Documentation

Installation

Add to composer

Install addon

Publish the addon

To customize and define your GraphQL service use the api:publish command.

This will publish the configuration and schema files to resources/{application}/addons/radic/graphql_streams_api.

Customization

You can customize/define the GraphQL service in resources/{application}/addons/radic/graphql_streams_api:

config/config.php
schema/queryable.graphqls
schema/core.graphqls

config.schema

output : The path where the schema will be generated.
imports : Paths to other schema definition files that will be included in the generated schema output.

config.stream_bindings

This defines the streams that you want to be generated as GraphQL types.

The resolutions are used to define the streams fields that should be in the GraphQL type. You can either:

Define only stream field name (like 'slugs'). The generator will use the default_field_bindings to resolve the GraphQL type automatically.
Define the stream field name and a custom GraphQL field type. This is usually done with relationship fields or if you want to add some directive(s) to the field.

Generate

After modifying the config.php or any of the defined schema.imports files you need to generate the output schema by running

This will generate the schema in the configured schema.output file path.

License

All versions of graphql_streams_api-module with dependencies

PHP Build Version

Package Version

Version 0.3.0 Release 12. Oct 2018
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of graphql_streams_api-module from vendor radic

Requires nuwave/lighthouse Version dev-master#a0ba2e80dd59adaafd55cdb4b8e60b874e232139 as ~2.2
deinternetjongens/lighthouse-utils Version ~0.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 radic/graphql_streams_api-module contains the following files

Loading the files please wait ....