A tool for generating api document from source code.
npm install -g @lanyue/tieLibrary
const tie = require('@lanyue/tie')
tie.parse(entry, options)
// or
const demo = new tie.Tie({ tag: 'api' }) // Defining block tags @tie => @api
demo.parse(text)tie controller/ --dest=docsIt will generated documents to the docs folder.
Usage: tie [options] <entry>
Extracting description to generate markdown document.
Options:
-V, --version output the version number
--dest <dir> output folder
--log [enable] enable logs (default: "0")
--match <pattern> match pattern (default: "**/*.js")
-i --ignore <file> ignore file (default: "node_modules/**/*.js")
-b --bundle <file> bundle handler javascript file
--json [filename] output json to file
-h, --help display help for commandbundle.js
// bundle.js
// Custom rendering handler
exports.render = async function ({ chunks, file, filename, meta, metaMarkdown }) {
console.log(file)
// Redefining rendering
return '# Hi'
}
// Do something else when you're done
exports.done = async function (files) {
console.log(files.length)
}@tie标记接口，有标记的注释才会被解析，放在注释开头@tie:<type>标记块类型，目前有meta，markdown类型@title接口名称@des接口说明@tags标签，多个逗号分隔@author作者，多个逗号分隔@version版本@route路由定义@typeBody 类型说明@headerHeader 键值对；可以多个@queryQuery 键值对；可以多个@bodyBody 键值对；可以多个@response响应字段说明；可以多个@code响应错误码，多个逗号分隔@change接口变更记录，可以多个@example请求案例说明
tie:meta
Meta block
/**
* @tie:meta
* @key value
* @key1 value1
* @key2 value2
* ...
* **/tie:markdown
Markdown block
/**
* @tie:markdown
* # Hi
* This is content...
* ...
* **/see demo
/**
* @tie
* @author lanyueos@qq.com,ohter@gmail.com
* @version 1.0
* @code 0,10,200
* @tags login,sign-in
* @change Add feature 1 (2020-11-17)
* @change Add feature 2 (2020-11-18)
* @route POST /test
* @title Sign In
* @des Log on user
* @query {number} [page=1] Page number
* @query {number} [page=] Page size
* @query {number} [pageSize=10] Page size
* @body {string} username Username
* @body {string} password Password
* @response {object} data User Profile
* @response {string} token Session Token
* @example example/login
* **/
function Func () {}Will be generated
### Sign In
`login`, `sign-in`
```
POST /test
```
Log on user
**Changes:**
+ Add feature 1 (2020-11-17)
+ Add feature 2 (2020-11-18)
#### Query
| Key | Type | Required | Default | Description |
| :-----| :---- | :----: | :---- | :---- |
| page | number | False | `1` | Page number |
| page | number | False | `` | Page size |
| pageSize | number | False | `10` | Page size |
#### Body
| Key | Type | Required | Default | Description |
| :-----| :---- | :----: | :---- | :---- |
| username | string | True | — | Username |
| password | string | True | — | Password |
#### Response
| Key | Type | Description |
| :-----| :---- | :---- |
| data | object | User Profile |
| token | string | Session Token |
**Errcode:**
+ `0`
+ `10`
+ `200`
#### Contact
+ [lanyueos@qq.com](#)
+ [ohter@gmail.com](#)
Support multi line comments
// @tie
// ...
// ...
// @tieEnd
// @tie
// @author lanyueos@qq.com,ohter@gmail.com
// @version 1.0
// @code 0,10,200
// @tags login,sign-in
// @change Add feature 1 (2020-11-17)
// @change Add feature 2 (2020-11-18)
// @route POST /foo
// @title Sign In
// @des Log on user
// @query {number} [page=1] Page number
// @query {number} [page=] Page size
// @query {number} [pageSize=10] Page size
// @body {string} username Username
// @body {string} password Password
// @response {object} data User Profile
// @response {string} token Session Token
// @example example/login
// @tieEnd
function Foo () {}