Skip to content

Commit

Permalink
README documentantion complement
Browse files Browse the repository at this point in the history
  • Loading branch information
sposmen committed Feb 26, 2014
1 parent 1aebc40 commit 36e27fd
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,55 @@ models:
type: String
```
## Read from jsdoc
Example 'api.coffee'
```coffee

###
* @swagger
* resourcePath: /api
* description: All about API
###

###
* @swagger
* path: /login
* operations:
* - httpMethod: POST
* summary: Login with username and password
* notes: Returns a user based on username
* responseClass: User
* nickname: login
* consumes:
* - text/html
* parameters:
* - name: username
* description: Your username
* paramType: query
* required: true
* dataType: string
* - name: password
* description: Your password
* paramType: query
* required: true
* dataType: string
###

###
* @swagger
* models:
* User:
* id: User
* properties:
* username:
* type: String
* password:
* type: String
###
```


## Examples

Expand Down

0 comments on commit 36e27fd

Please sign in to comment.