This repository contains Netlify's API definition in the Open API format, formerly known as Swagger.
It's still a work in progress and we welcome feedback and contributions.
The spec is published and versioned for various ecosystems:
$ go get github.com/netlify/open-api/...
- Porcelain: High level interactions and operations
- Plumbing: Low level client operations generated by go-swagger
- Models: Models generated by go-swagger
See CONTRIBUTING.md for details on how this client is developed and generated.
We have a fully featured JS/Node.js client that implements some of the same 'porcelain' methods that the go client does in addition to the open-api methods.
See github.com/netlify/build/tree/main/packages/js-client for more details.
You can also consume the swagger spec as an npm module:
$ npm install @netlify/open-api # or $ yarn add @netlify/open-api
import spec from '@netlify/open-api' // import the spec object into your project
The module also ships a copy of the original
yml spec file at
@netlify/open-api/js/dist/swagger.yml. You can use these with generic swagger/open-api clients:
Swagger's JS client can dynamically create a client from a spec either from a URL or spec object.
See the swagger-js client:
See CONTRIBUTING.md for more info on how to make contributions to this project.
MIT. See LICENSE for more details.