Skip to content

Commit 39ca987

Browse files
committed
Updates the README file.
1 parent 3b86bff commit 39ca987

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,12 @@ Configure {swagger-express} as express middleware.
2020

2121
`swaggerVersion` -> Swagger version.
2222

23-
`basePath` -> This is the base path of the server declaring the apis.
24-
2523
`swaggerUI` -> Where is your swagger-ui?
2624

25+
`swaggerURL` -> Path to use for swagger ui web interface.
26+
27+
`swaggerJSON` -> Path to use for swagger ui JSON.
28+
2729
`apis` -> Define your api array.
2830

2931
```
@@ -34,7 +36,8 @@ app.configure(function(){
3436
app.use(swagger.init(app, {
3537
apiVersion: '1.0',
3638
swaggerVersion: '1.0',
37-
basePath: 'http://localhost:3000',
39+
swaggerURL: '/swagger',
40+
swaggerJSON: '/api-docs.json',
3841
swaggerUI: './public/swagger/',
3942
apis: ['./api.js', './api.yml']
4043
}));

0 commit comments

Comments
 (0)