README
¶
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:
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]
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
componentsv2
Package componentsv2 is a reverse proxy.
|
Package componentsv2 is a reverse proxy. |
|
cryptographyv2
Package cryptographyv2 is a reverse proxy.
|
Package cryptographyv2 is a reverse proxy. |
|
dependenciesv2
Package dependenciesv2 is a reverse proxy.
|
Package dependenciesv2 is a reverse proxy. |
|
geoprovenancev2
Package geoprovenancev2 is a reverse proxy.
|
Package geoprovenancev2 is a reverse proxy. |
|
licensesv2
Package licensesv2 is a reverse proxy.
|
Package licensesv2 is a reverse proxy. |
|
scanningv2
Package scanningv2 is a reverse proxy.
|
Package scanningv2 is a reverse proxy. |
|
semgrepv2
Package semgrepv2 is a reverse proxy.
|
Package semgrepv2 is a reverse proxy. |
|
vulnerabilitiesv2
Package vulnerabilitiesv2 is a reverse proxy.
|
Package vulnerabilitiesv2 is a reverse proxy. |
|
tests
|
|
|
go/client
command
**
|
** |
|
go/comp_server
command
|
|
|
go/crypto_server
command
|
|
|
go/dep_server
command
**
|
** |
|
go/scan_server
command
|
Click to show internal directories.
Click to hide internal directories.