https://github.com/zanjs/zanapi-node
https://github.com/zanjs/zanapi-node
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zanjs/zanapi-node
- Owner: zanjs
- Created: 2017-01-01T04:38:31.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-09-09T07:23:56.000Z (over 6 years ago)
- Last Synced: 2025-02-04T09:19:05.013Z (11 months ago)
- Language: JavaScript
- Size: 226 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# zanApi
Generates a RESTful web API Documentation.
## Installation
`npm install zanapi -g`
## Example
```javascript
/**
* @api {get} /user/:id Request User information
* @apiName GetUser
* @apiGroup User
*
* @apiParam {Number} id Users unique ID.
*
* @apiSuccess {String} firstname Firstname of the User.
* @apiSuccess {String} lastname Lastname of the User.
*/
```
`zanapi -i example/ -o doc/`
Creates from input files in `example/` a documentation in path `doc/`.
## Supported programming languages
* **C#, Go, Dart, Java, JavaScript, PHP, Scala** (all DocStyle capable languages):
```javascript
/**
* This is a comment.
*/
```
* **Clojure**:
```clojure
;;;;
;; This is a comment.
;;;;
```
* **CoffeeScript**:
```coffeescript
###
This is a comment.
###
```
* **Erlang**:
```erlang
%{
This is a comment.
%}
```
* **Perl**
```perl
#**
# This is a comment.
#*
```
```perl
=pod
This is a comment.
=cut
```
* **Python**
```python
"""
This is a comment.
"""
```
* **Ruby**
```ruby
=begin
This is a comment.
=end
```