Skip to content

Commit 21adb7b

Browse files
committed
updated package version, readme
1 parent 3ef263d commit 21adb7b

File tree

2 files changed

+19
-17
lines changed

2 files changed

+19
-17
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The Swagger Specification has undergone 3 revisions since initial creation in 20
2020

2121
Swagger UI Version | Release Date | Swagger Spec compatibility | Notes | Status
2222
------------------ | ------------ | -------------------------- | ----- | ------
23-
2.1.0-alpha.7 (in development) | 2014-10-06 | 1.1, 1.2, 2.0 | [master](https://github.com/swagger-api/swagger-ui/tree/develop_2.0) | [Issues](https://github.com/swagger-api/swagger-ui/milestones/v2.1.0)
23+
2.1.0-M1 | 2015-01-31 | 1.1, 1.2, 2.0 | [master](https://github.com/swagger-api/swagger-ui) | [Issues](https://github.com/swagger-api/swagger-ui/issues)
2424
2.0.24 | 2014-09-12 | 1.1, 1.2 | [tag v2.0.24](https://github.com/swagger-api/swagger-ui/tree/v2.0.24) |
2525
1.0.13 | 2013-03-08 | 1.1, 1.2 | [tag v1.0.13](https://github.com/swagger-api/swagger-ui/tree/v1.0.13) |
2626
1.0.1 | 2011-10-11 | 1.0, 1.1 | [tag v1.0.1](https://github.com/swagger-api/swagger-ui/tree/v1.0.1) |
@@ -34,11 +34,11 @@ You can use the swagger-ui code AS-IS! No need to build or recompile--just clon
3434
You can rebuild swagger-ui on your own to tweak it or just so you can say you did. To do so, follow these steps:
3535

3636
1. `npm install`
37-
2. `npm run build`
37+
2. `gulp`
3838
3. You should see the distribution under the dist folder. Open [`./dist/index.html`](./dist/index.html) to launch Swagger UI in a browser
3939

4040
### Development
41-
Use `npm run build` to make a new build and `npm run serve` to start web server that will serve `dist` directory, watches for changes in files and reloads the page.
41+
Use `gulp watch` to make a new build and watch for changes in files.
4242

4343
### Build using Docker
4444

@@ -59,27 +59,26 @@ docker run -v $PWD/dist:/build/dist swagger-ui-builder
5959
```
6060

6161
### Use
62-
Once you open the Swagger UI, it will load the [Swagger Petstore](http://petstore.swagger.wordnik.com/api/api-docs) service and show its APIs. You can enter your own server url and click explore to view the API.
62+
Once you open the Swagger UI, it will load the [Swagger Petstore](http://petstore.swagger.wordnik.com/v2/swagger.json) service and show its APIs. You can enter your own server url and click explore to view the API.
6363

6464
### Customize
6565
You may choose to customize Swagger UI for your organization. Here is an overview of whats in its various directories:
6666

6767
- dist: Contains a distribution which you can deploy on a server or load from your local machine.
68-
- bin: Contains files used by swagger-ui for its build/test. These are not required by the distribution.
6968
- lib: Contains javascript dependencies which swagger-ui depends on
7069
- node_modules: Contains node modules which swagger-ui uses for its development.
7170
- src
72-
- src/main/coffeescript: main code in CoffeeScript
73-
- src/main/templates: [handlebars](http://handlebarsjs.com/) templates used to render swagger-ui
74-
- src/main/html: the html files, some images and css
75-
- src/main/javascript: some legacy javascript referenced by CoffeeScript code
71+
- src/main/coffeescript: main code in CoffeeScript
72+
- src/main/templates: [handlebars](http://handlebarsjs.com/) templates used to render swagger-ui
73+
- src/main/html: the html files, some images and css
74+
- src/main/javascript: some legacy javascript referenced by CoffeeScript code
7675

7776
### SwaggerUi
78-
To use swagger-ui you should take a look at the [source of swagger-ui html page](https://github.com/swagger-api/swagger-ui/tree/master/src/main/html) and customize it. This basically requires you to instantiate a SwaggerUi object and call load() on it as below:
77+
To use swagger-ui you should take a look at the [source of swagger-ui html page](https://github.com/swagger-api/swagger-ui/blob/master/dist/index.html) and customize it. This basically requires you to instantiate a SwaggerUi object and call load() on it as below:
7978

8079
```javascript
8180
window.swaggerUi = new SwaggerUi({
82-
url:"http://petstore.swagger.wordnik.com/api/api-docs",
81+
url:"http://petstore.swagger.wordnik.com/v2/swagger.json",
8382
dom_id:"swagger-ui-container"
8483
});
8584

@@ -155,9 +154,9 @@ You can verify CORS support with one of three techniques:
155154
- Curl your API and inspect the headers. For instance:
156155

157156
```bash
158-
$ curl -I "http://petstore.swagger.wordnik.com/api/api-docs"
157+
$ curl -I "http://petstore.swagger.wordnik.com/v2/swagger.json"
159158
HTTP/1.1 200 OK
160-
Date: Thu, 12 Sep 2013 17:05:44 GMT
159+
Date: Sat, 31 Jan 2015 23:05:44 GMT
161160
Access-Control-Allow-Origin: *
162161
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, PATCH, OPTIONS
163162
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
@@ -203,7 +202,7 @@ Since the javascript files are compiled from coffeescript, please submit changes
203202

204203
## License
205204

206-
Copyright 2011-2014 Reverb technologies, Inc.
205+
Copyright 2011-2015 Reverb technologies, Inc.
207206

208207
Licensed under the Apache License, Version 2.0 (the "License");
209208
you may not use this file except in compliance with the License.

package.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@
1818
},
1919
"license": "Apache",
2020
"readmeFilename": "README.md",
21-
"dependencies": {},
21+
"dependencies": {
22+
"shred": "0.8.10",
23+
"btoa": "1.1.1",
24+
"swagger-client": "2.1.0-M1"
25+
},
2226
"devDependencies": {
2327
"chai": "^1.10.0",
2428
"cors": "2.1.1",
@@ -41,7 +45,6 @@
4145
"http-server": "^0.7.4",
4246
"less": "~1.4.2",
4347
"mocha": "^2.1.0",
44-
"selenium-webdriver": "^2.44.0",
45-
"swagger-client": "2.1.0-alpha.7"
48+
"selenium-webdriver": "^2.44.0"
4649
}
4750
}

0 commit comments

Comments
 (0)