Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 2.42 KB

README.md

File metadata and controls

69 lines (48 loc) · 2.42 KB
Raw

deps.dev API

deps.dev is a service developed and hosted by Google to help developers better understand the structure, construction, and security of open source software packages.

The deps.dev API can be accessed in two ways: as JSON over HTTP, as well as via gRPC. This repository contains the service definition for the gRPC API, along with example applications for both APIs.

Using the HTTP API

The HTTP API can be accessed using any HTTP client. To quickly get started, you can use the curl command-line tool. Example:

curl 'https://api.deps.dev/v3alpha/systems/npm/packages/%40colors%2Fcolors'

Note that the @ and / in the package name have been percent-encoded.

For complete documentation on the HTTP API, please visit docs.deps.dev.

Using the gRPC API

The gRPC API can be accessed using any gRPC client. The service definition, which describes the methods of the API along with their request and response messages, can be found in api/v3alpha/api.proto

To quickly get started exploring the API, you can use the grpcurl command-line tool. Example:

grpcurl \
  -d '{"package_key":{"system":"NPM","name":"@colors/colors"}}' \
  api.deps.dev:443 \
  deps_dev.v3alpha.Insights/GetPackage

Example applications

Example applications written in Go can be found in the examples directory:

  • artifact_query shows how to query the deps.dev HTTP API by file content hash.
  • dependencies_dot fetches a resolved dependency graph from the deps.dev HTTP API and renders it in the DOT language used by Graphviz.
  • package_lock_licenses reads dependencies from an npm package-lock.json file and fetches their licenses from the deps.dev gRPC API.

Third party tools and integrations

Note that these are community built tools and unsupported by the core deps.dev maintainers.

Contact us

If you have questions about the API, or want to report a problem, please create an issue or contact us at [email protected].

Terms

Use of the deps.dev API is subject to the Google API Terms of Service.