https://github.com/scanoss/papi
Public APIs for SCANOSS Platform 2.0
https://github.com/scanoss/papi
Last synced: about 2 months ago
JSON representation
Public APIs for SCANOSS Platform 2.0
- Host: GitHub
- URL: https://github.com/scanoss/papi
- Owner: scanoss
- License: mit
- Created: 2021-12-03T14:07:36.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-04-15T17:30:43.000Z (about 2 months ago)
- Last Synced: 2026-04-15T18:34:47.976Z (about 2 months ago)
- Language: Shell
- Homepage:
- Size: 864 KB
- Stars: 4
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
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:
* [Protocol Buffer Definitions](protobuf)
* [Go API library Implementation](api)
## Consumption
To consume the Public APIs, simply use one of the following:
* Go - [github.com/scanoss/papi](https://github.com/scanoss/papi)
* Python - [scanoss](https://pypi.org/project/scanoss/)
* Javascript - [scanoss](https://www.npmjs.com/package/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](LIBRARY_BUILD.md).
### Go
Examples of consuming the Go library can be found in the [tests/go](tests/go) folder.
### Python
Examples of consuming the Python Library can be found [here](https://github.com/scanoss/scanoss.py).
### Javascript
Examples of consuming the Javascript Library can be found [here](https://github.com/scanoss/scanoss.js).
### Java
TBD
## Build
For details on how to compile the supported language libraries, please look in [LIBRARY_BUILD.md](LIBRARY_BUILD.md).
# Architecture
```mermaid
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]
```