/brapi

Breeding API client-server implementation for Tripal 2 & 3

Primary LanguagePHP

Plant Breeding API server


Plant Breeding API server implementation for Drupal.

===============================

CONTENTS OF THIS FILE

  • Introduction
  • Requirements
  • Installation
  • Configuration
  • Maintainers

INTRODUCTION

Version 9.x-4.x is a complete rewrite of the BrAPI module for Drupal 8+. This module only contains the BrAPI server part. For a Drupal BrAPI client, see External Entities BrAPI Storage plugin ( https://www.drupal.org/project/xnttbrapi/).

You can configure wich version of BrAPI your site support (1.x and/or 2.x). To enable a call, you need first to map all the data types it is using to Drupal content types. Then, you can enable the call. Each data type is related to a given BrAPI version and mappings are also version related.

BrAPI calls are handled through: /brapi/v<1 or 2>/[parameters such as: ?page=0&pageSize=10]

Current alpha support: -simple calls for listing and displaying a single element (read only) -pager -some filters -only simple fields can be mapped (composed/object fields not supported yet) -permissions are not fully managed -only JSON output

REQUIREMENTS

none.

INSTALLATION

CONFIGURATION

Got to your site /brapi/admin/ page. From there, you can manage supported BrAPI version, data types mapping (/brapi/admin/datatypes) and enabled calls (/brapi/admin/calls).

MAINTAINERS

Current maintainers: