You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -34,11 +34,11 @@ You can use the swagger-ui code AS-IS! No need to build or recompile--just clon
34
34
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:
35
35
36
36
1.`npm install`
37
-
2.`npm run build`
37
+
2.`gulp`
38
38
3. You should see the distribution under the dist folder. Open [`./dist/index.html`](./dist/index.html) to launch Swagger UI in a browser
39
39
40
40
### 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.
42
42
43
43
### Build using Docker
44
44
@@ -59,27 +59,26 @@ docker run -v $PWD/dist:/build/dist swagger-ui-builder
59
59
```
60
60
61
61
### 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.
63
63
64
64
### Customize
65
65
You may choose to customize Swagger UI for your organization. Here is an overview of whats in its various directories:
66
66
67
67
- 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.
69
68
- lib: Contains javascript dependencies which swagger-ui depends on
70
69
- node_modules: Contains node modules which swagger-ui uses for its development.
71
70
- 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
76
75
77
76
### 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:
0 commit comments