The Sweater Comb project is an executable manifestation of Snyk's API standards.
Built with and powered by Optic CI with 💜.
Read more about the Sweater Comb project: how to install, use, deploy, contribute...
Snyk's API program aims to maximize the value we provide to developers and the extensibility of the Snyk platform through APIs.
Read more about the Snyk API Program.
JSON API is an emerging industry standard for representing RESTful resources as JSON data. JSON API's innovation is it's normalization of how entities are expressed, represented, structured, and how these entities relate to each other.
We at Snyk found JSON API to be an excellent starting point for a resource-based API, formatting and structuring JSON data in requests and responses. Leveraging JSON API's opinionated choices enabled us to focus more on designing and building the actual content of the Snyk API.
Read how Snyk has adopted and adapted JSON API into the Snyk API program.
Read more about how the Snyk API is versioned.
Dive into the details of the Snyk REST API Standard.
This documentation is developed for mkdocs and specifically Backstage TechDocs. While it is viewable and navigable directly out of Github for the most part, some links and formatting may only work properly when rendered with mkdocs.