npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

api-service-sparql

v0.3.8

Published

REST API for named sparql queries

Downloads

1

Readme

A6S API: sparql Query API

This API uses named sparql queried to create a API adapter into the Governance Graph.

It's implemented as a microservice that maps URL sub-paths to named sparql queries.

The config/default.yaml is used to configure the chassis, specificially the 'sparqlclient' plugin.

The built-in "openapi" plugin is used to map /:query/ requests to the 'sparqlclient' operation.

Query Processing

The ./sparql/ folder contains a set of named sparql queries.

The API path is parsed to extract the named query.

The requests query parameters can be bound to named query variables.

Consider the query "this.sparql":

SELECT DISTINCT ?name ?value WHERE { ?this ?name ?value}

The "?this" variable can be bound at request time using the "?this" query parameter:

CURL http://localhost:7000/gg/this?this=http://example.com/

Special Variable: ?this

All query parameters are interpreted as string literals except for ?this which is always converted into a URI.

SparqlClient plugin

The sparqlclient is an opionated way to execute sparql queries:

  1. translates a query name into a sparql filename
  2. read sparql file from "queryPath" folder
  3. forward the sparql query to the remote endpoint
  4. format the results
  5. handle errors

Options

The "sparqlclient" options can be specified as a global config or within relevent the "openapi" definition.

sparqlclient:
  endpoint: http://localhost:8080/rdf4j-server/repositories/example
  queryPath: "./sparql"
  ns:
    rdf: http://www.w3.org/1999/02/22-rdf-syntax-ns#
    rdfs: http://www.w3.org/2000/01/rdf-schema#
    dc: http://purl.org/dc/elements/1.1/
    eg: http://www.example.org/

The "endpoint" refers to an external sparql 1.x HTTP endpoint. The "queryPath" refers to the folder containing the sparql queries. The "ns" is a namespace map used as defaults for the sparql queries.

openapi plugin

The chassis is configured by an OpenAPI definition. The "operationId" fields must be mapped to a valid plugin.

The "operationId" can be used in more than one path - which is different from the Swagger/Open API specification.

openapi:
  paths:
    /healthz:
      get:
        chassis:
          operationId: heartbeat
    /swagger:
      get:
        chassis:
          operationId: apidocs

    /types:
      get:
        chassis:
          operationId: SPARQL
        params:
          query: rdfs_types
    "/:query":
      get:
        chassis:
          operationId: SPARQL

For example:

$ npm install && npm start
$ curl -v http://localhost:7001/types

This /types/ API is mapped to the rdfs_types.sparql file in the ./sparql/ folder.

Governance Graph

The govgraph.ttl file contains a a6s:Solution graph describing the OpenAPI and it's runtime components.

:api-service-sparql
    a               a6s:Solution;
    a               k8s:DockerImage;
    a               k8s:HelmChart;

    dc:title        "A6S APIs: Core Insights";
    k8s:name        "api-service-sparql";

    a6s:feature     <https://api.apigeeks.com/v1/gg/sparql/:query>;
    a6s:feature     <https://api.apigeeks.com/v1/gg/healthz/sparql>;
    a6s:feature     <https://api.apigeeks.com/v1/gg/openapi/sparql>;
.

Docker Demo

docker run --rm -p 8080:8080 yyz1989/rdf4j

curl -H "Content-Type: application/json" -X POST --data '{"this":"https://api.apigeeks.com/v1/gg/openapi/sparql/"}' http://localhost:7001/gg/this