SCANOSS Platform 2.0 Public APIs

Welcome to the public APIs for the SCANOSS Platform 2.0

Warning Work In Progress Warning

Repository Structure

This repository is made up of the following components:

• Protocol Buffer Definitions
• Go API library Implementation

Consumption

To consume the Public APIs, simply use one of the following:

• Go - github.com/scanoss/papi
• Python - scanoss
• Javascript - scanoss
• Java - TBD

Or alternatively, take the protocol buffer definitions and compile them for your language of choice.

Details on how the supported languages are compiled can be found here.

Go

Examples of consuming the Go library can be found in the tests/go folder.

Python

Examples of consuming the Python Library can be found here.

Javascript

Examples of consuming the Javascript Library can be found here.

Java

TBD

Build

For details on how to compile the supported language libraries, please look in LIBRARY_BUILD.md.

Architecture

graph LR
    A[HTTP/JSON Client] -->|REST| B[gRPC-Gateway]
    C[gRPC Client] -->|gRPC| D[gRPC Server]
    B -->|gRPC| D
    B -.->|generates| E[Swagger/OpenAPI]

Loading