Skip to content

Commit 4f27c86

Browse files
committed
Update README.md
1 parent 6a2e19c commit 4f27c86

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,16 @@ Just another swagger + express integration, but this is much simple and clean.
1010

1111
Configure {swagger-express} as express middleware.
1212

13-
'apiVersion' -> Your api version.
1413

15-
'swaggerVersion' -> Swagger version.
14+
`apiVersion` -> Your api version.
1615

17-
'basePath' -> This is the base path of the server declaring the apis.
16+
`swaggerVersion` -> Swagger version.
1817

19-
'swaggerUI' -> Where is your swagger-ui?
18+
`basePath` -> This is the base path of the server declaring the apis.
2019

21-
'apis' -> Define your api array.
20+
`swaggerUI` -> Where is your swagger-ui?
21+
22+
`apis` -> Define your api array.
2223

2324
```
2425
var swagger = require('../');
@@ -37,6 +38,7 @@ app.configure(function(){
3738
});
3839
```
3940
- Read from jsdoc
41+
-
4042
Example 'api.js'
4143

4244
```js
@@ -91,8 +93,8 @@ exports.login = function (req, res) {
9193
```
9294

9395
- Read from yaml file
94-
Example 'api.yml'
9596

97+
Example 'api.yml'
9698

9799
```yml
98100
resourcePath: /api
@@ -131,7 +133,7 @@ models:
131133
type: String
132134
password:
133135
type: String
134-
...
136+
```
135137
136138
137139
## Examples

0 commit comments

Comments
 (0)