API基础信息
API信息的定义在app/config.json
文件中:
config.json
{
"api": {
"name" : "users"
}
}
可配置的属性请参考下表:
Field | Type | Description |
---|---|---|
name | string |
Required API的名称 |
version | string |
API的版本,默认为1.0.0 |
basePath | string |
基础路径,默认为/ |
title | string |
API的标题 |
description | string |
API描述,另外也可以按API文档的方式编写 |