Public | Automated Build

Last pushed: 7 months ago
Short Description
Short description is empty for this repo.
Full Description

OPS LinkedDataApi

The Linked Data API for Open PHACTS.

Based on the Puelia PHP implementation
of the Linked Data API specification.

This is a repository to host API configuration files
and code extensions

Requirements are php 5.2, with php_xsl, lib_curl, and mod_rewrite and .htaccess override enabled.

Make sure that Apache's DocumentRoot directory and (all parent directories from /var/ forward) are writable by the user running Apache

Docker image

This application is also available as a Docker image:
openphacts/ops-linkeddataapi

This image will provide the Open PHACTS API on HTTP port 80, which can be exposed
using the -p docker parameter.

This image relies on linking to these other docker images as the following aliases:

Details about starting and populating those are provided at their respective READMEs.
The simplest option to start up the Open PHACTS platform is usually the
ops-platform-setup configuration for Docker Compose.

Additionally these environment variables define the external services for
ConceptWiki and
Chemical Resolution Service (these are not
currently available as Docker containers):

The default values for these access the aliases crs and conceptwiki, but
if you don't have your own installation of these services, you might use the
public services, by adding the following to docker run:

--env CRS=https://ops.rsc.org/api/v1/ \
--env CONCEPTWIKI=http://www.conceptwiki.org/web-ws/concept

Example Docker run

To run:

docker run --name ops-linkeddataapi -p 8081:80 \
  --env CRS=https://ops.rsc.org/api/v1/ \
  --env CONCEPTWIKI=http://www.conceptwiki.org/web-ws/concept \
  --link memcached:memcached \
  --link identitymappingservice:ims \
  --link virtuoso:sparql \
  -d openphacts/ops-linkeddataapi

The above will expose the Open PHACTS Linked Data API on
http://localhost:8081 (or equivalent)
and link to existing Docker containers memcached, identitymappingservice
and virtuoso (which must already be running), and the
public APIs for CRS and
ConceptWiki.

Swagger

The API includes a Swagger definition in JSON
for the exposed services, available at /swagger - for example
http://localhost:8081/swagger

Note that the hostname and port returned as basePath here
depends on the URL the swagger file is accessed at. If you are
exposing the API via a proxy, the swagger definition might be
wrongly exposing the internal URI.

To override the basePath, set the BASE_PATH environment variable.

For example:

docker run -p 8081:80 \
  --env BASE_PATH=http://cool.example.com/ \
  -d openphacts/ops-linkeddataapi
Docker Pull Command
Owner
openphacts
Source Repository

Comments (0)