1
1
# open-api
2
- [ ![ Build Status] ( https://travis-ci.org/netlify/open-api.svg?branch=master )] ( https://travis-ci.org/netlify/open-api ) [ ![ Build status] ( https://ci.appveyor.com/api/projects/status/qrmvxk957ou2yrd9/branch/master?svg=true )] ( https://ci.appveyor.com/project/netlify/open-api/branch/master )
2
+ [ ![ Build Status] [ travis-img ]] [ travis ]
3
+ [ ![ Build status] ( [av-img] )] [ av ]
3
4
4
- This repository contains Netlify's API definition in the [ Open API format] ( https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md ) (AKA Swagger) .
5
+ This repository contains Netlify's API definition in the [ Open API format] [ open-api-2 ] , formerly known as Swagger.
5
6
6
- The spec is currently incomplete but includes many common endpoints .
7
+ It's still a work in progress and we welcome feedback and contributions .
7
8
8
9
## Usage
9
10
@@ -19,7 +20,9 @@ You can view the definition using [Swagger UI](https://swagger.io/tools/swagger-
19
20
20
21
### Go Client
21
22
22
- [ ![ GoDoc] ( https://godoc.org/github.com/netlify/open-api/go?status.svg )] ( https://godoc.org/github.com/netlify/open-api/go ) [ ![ Go Report Card] ( https://goreportcard.com/badge/github.com/netlify/open-api )] ( https://goreportcard.com/report/github.com/netlify/open-api ) [ ![ Github release] ( https://img.shields.io/github/release/netlify/open-api.svg )] ( https://github.com/netlify/open-api/releases/latest )
23
+ [ ![ GoDoc] [ godoc-img ]] [ godoc ]
24
+ [ ![ Go Report Card] [ goreport-img ]] [ goreport ]
25
+ [ ![ Github release] [ github-img ]] [ github ]
23
26
24
27
``` console
25
28
$ go get github.com/netlify/open-api/...
@@ -33,7 +36,7 @@ See [CONTRIBUTING.md#go-client](CONTRIBUTING.md) for details on how this client
33
36
34
37
### npm module
35
38
36
- [ ![ npm version] [ 2 ]] [ 3 ]
39
+ [ ![ npm version] [ npm-img ]] [ npm ]
37
40
38
41
You can also consume the swagger spec as an npm module:
39
42
@@ -53,8 +56,7 @@ The module also ships a copy of the original `yml` spec file at `@netlify/open-a
53
56
54
57
Swagger's JS client can dynamically create a client from a spec either from a URL or spec object.
55
58
56
- See [ swagger-js] ( https://github.com/swagger-api/swagger-js )
57
-
59
+ See the [ swagger-js] ( https://github.com/swagger-api/swagger-js ) client:
58
60
59
61
##### Usage
60
62
``` js
@@ -72,5 +74,18 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more info on how to make contribution
72
74
73
75
MIT. See [ LICENSE] ( LICENSE ) for more details.
74
76
75
- [ 2 ] : https://img.shields.io/npm/v/@netlify/open-api.svg
76
- [ 3 ] : https://npmjs.org/package/@netlify/open-api
77
+ [ travis-img ] : https://travis-ci.org/netlify/open-api.svg?branch=master
78
+ [ travis ] : https://travis-ci.org/netlify/open-api
79
+ [ av-img ] : https://ci.appveyor.com/api/projects/status/qrmvxk957ou2yrd9/branch/master?svg=true
80
+ [ av ] : https://ci.appveyor.com/project/netlify/open-api/branch/master
81
+ [ npm-img ] : https://img.shields.io/npm/v/@netlify/open-api.svg
82
+ [ npm ] : https://npmjs.org/package/@netlify/open-api
83
+
84
+ [ godoc-img ] : https://godoc.org/github.com/netlify/open-api/go?status.svg
85
+ [ godoc ] : https://godoc.org/github.com/netlify/open-api/go
86
+ [ goreport-img ] : https://goreportcard.com/badge/github.com/netlify/open-api
87
+ [ gorepot ] : https://goreportcard.com/report/github.com/netlify/open-api
88
+ [ git-img ] : https://img.shields.io/github/release/netlify/open-api.svg
89
+ [ git ] : https://github.com/netlify/open-api/releases/latest
90
+
91
+ [ open-api-2 ] : https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
0 commit comments