zbk_api v1.0.3
test_center
TestCenter - JavaScript client for test_center No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install test_center --save
Finally, you need to build the module:
npm run build
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your test_center from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
git
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var TestCenter = require('test_center');
var api = new TestCenter.CollectionApi()
var collectionName = "collectionName_example"; // {String}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.deleteCollectionsCollectionName(collectionName, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
TestCenter.CollectionApi | deleteCollectionsCollectionName | DELETE /collections/{collectionName} | 删除Collection |
TestCenter.CollectionApi | getCollections | GET /collections | 获取所有的数据集合 |
TestCenter.CollectionApi | getCollectionsCollectionName | GET /collections/{collectionName} | 获取Collection信息 |
TestCenter.CollectionApi | getCollectionsCollectionNameProperties | GET /collections/{collectionName}/properties | 获取集合中记录所有的Property |
TestCenter.CollectionApi | postCollectionsCollectionNameUpload | POST /collections/{collectionName}/upload | 上传excel文件 |
TestCenter.CollectionApi | postCollectionsDocs | POST /collections/{collectionName}/docs | 批量上传文档 |
TestCenter.CollectionApi | putCollectionsCollectionName | PUT /collections/{collectionName} | 创建Collection |
TestCenter.FieldApi | deleteEnumGroupName | DELETE /enum_group/{name} | 删除某一个枚举组 |
TestCenter.FieldApi | deleteEnumGroupNameEnumName | DELETE /enum_group/{name}/{enum_name} | 删除具体的某一个枚举 |
TestCenter.FieldApi | deleteFieldDefinitionName | DELETE /field_definition/{name} | 删除某一个字段 |
TestCenter.FieldApi | getEnumGroup | GET /enum_group_list | 获取所有枚举组 |
TestCenter.FieldApi | getEnumGroupName | GET /enum_group/{name} | 获取某一个枚举组 |
TestCenter.FieldApi | getEnumGroupNameEnumName | GET /enum_group/{name}/{enum_name} | 获取具体的某一个枚举 |
TestCenter.FieldApi | getFieldDefinition | GET /field_definition/{name} | 获取某一个字段的定义 |
TestCenter.FieldApi | getFields | GET /field_definition_list | 获取所有字段的定义 |
TestCenter.FieldApi | postFieldDefinitionName | POST /field_definition/{name} | 更新某一个字段 |
TestCenter.FieldApi | putEnumGroupNameEnumName | PUT /enum_group/{name}/{enum_name} | 新增具体的某一个枚举 |
TestCenter.FieldApi | putFieldDefinitionName | PUT /field_definition/{name} | 增加某一个字段 |
TestCenter.IndexApi | deleteIndicesIndexName | DELETE /indices/{indexName} | 删除索引 |
TestCenter.IndexApi | getIndicesIndexName | GET /indices/{indexName} | 获取index |
TestCenter.IndexApi | getIndicesIndexNameDoc | GET /indices/{indexName}/doc/{docId} | 获取文档 |
TestCenter.IndexApi | getIndicesIndexNameSearch | GET /indices/{indexName}/search | 查询文档 |
TestCenter.IndexApi | postIndicesIndexName | POST /indices/{indexName} | 更新index |
TestCenter.IndexApi | postIndicesIndexNameActive | POST /indices/{indexName}/active | 激活Index,开始导入数据 |
TestCenter.IndexApi | postIndicesIndexNameAppend | POST /indices/{indexName}/append | 刷新并追加Index的数据 |
TestCenter.IndexApi | putIndicesIndexName | PUT /indices/{indexName} | 添加index |
TestCenter.IndexApi | putIndicesIndexNameDocDocId | PUT /indices/{indexName}/doc/{docId} | 更新文档 |
TestCenter.TableApi | deleteTableName | DELETE /table/{name} | 删除一个table |
TestCenter.TableApi | deleteTableTableNameDefinitionTableFieldName | DELETE /table/{table_name}/definition/{table_field_name} | 删除某一个table的某一个字段的定义 |
TestCenter.TableApi | getTable | GET /table/{name} | 获取某一个table |
TestCenter.TableApi | getTableList | GET /table_list | 获取所有的table |
TestCenter.TableApi | getTableNameDefinitionTableFieldName | GET /table/{table_name}/definition/{table_field_name} | 获取某一个table的某一个字段的定义 |
TestCenter.TableApi | postTableName | POST /table/{name} | 修改一个table |
TestCenter.TableApi | postTableTableNameDefinitionTableFieldName | POST /table/{table_name}/definition/{table_field_name} | 更新某一个table的某一个字段的定义 |
TestCenter.TableApi | putTableName | PUT /table/{name} | 创建一个table |
TestCenter.TableApi | putTableTableNameDefinitionTableFieldName | PUT /table/{table_name}/definition/{table_field_name} | 新增某一个table的某一个字段的定义 |
Documentation for Models
- TestCenter.CollectionModel
- TestCenter.DocumentModel
- TestCenter.FieldDefinitionModel
- TestCenter.FieldEnumGroupModel
- TestCenter.FieldEnumModel
- TestCenter.IndexModel
- TestCenter.JobModel
- TestCenter.MappingModel
- TestCenter.ProblemModel
- TestCenter.PropertyModel
- TestCenter.RestrictModel
- TestCenter.TableFieldDefinitionModel
- TestCenter.TableModel
Documentation for Authorization
Authentication schemes defined for the API:
BearerAuth
- Type: Bearer authentication