https://github.com/yanxi123-com/rest-api-doc

Define you api in coffee script, then generate the api document.
https://github.com/yanxi123-com/rest-api-doc

Last synced: 14 days ago
JSON representation

Define you api in coffee script, then generate the api document.

• Host: GitHub
• URL: https://github.com/yanxi123-com/rest-api-doc
• Owner: yanxi123-com
• License: other
• Created: 2015-04-09T07:50:20.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-09-11T07:14:45.000Z (about 9 years ago)
• Last Synced: 2024-10-22T02:01:40.664Z (30 days ago)
• Language: JavaScript
• Homepage:
• Size: 2.12 MB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
rest-api-doc

=====================================

### Put you API in api directory:

[put your apis here](./api)

### install

```

npm install

npm install -g gulp

```

### Run dev

```

gulp dev

```

### deploy dev

```

gulp deploy-dev

```

### Run production

```

gulp prod

```

## api doc structure

```coffee

name: String

baseUrl: String

description: String

apis: [{

  title: String

  description: String   # optional

  url: String

  method: String    # POST, GET

  body: bodyStructure

  successResponse: successResponseStructure

  errorResponse: errorResponseStructure

}]

```