1.0.3 • Published 1 year ago

zbk_api v1.0.3

Weekly downloads
-
License
Unlicense
Repository
-
Last release
1 year ago

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

ClassMethodHTTP requestDescription
TestCenter.CollectionApideleteCollectionsCollectionNameDELETE /collections/{collectionName}删除Collection
TestCenter.CollectionApigetCollectionsGET /collections获取所有的数据集合
TestCenter.CollectionApigetCollectionsCollectionNameGET /collections/{collectionName}获取Collection信息
TestCenter.CollectionApigetCollectionsCollectionNamePropertiesGET /collections/{collectionName}/properties获取集合中记录所有的Property
TestCenter.CollectionApipostCollectionsCollectionNameUploadPOST /collections/{collectionName}/upload上传excel文件
TestCenter.CollectionApipostCollectionsDocsPOST /collections/{collectionName}/docs批量上传文档
TestCenter.CollectionApiputCollectionsCollectionNamePUT /collections/{collectionName}创建Collection
TestCenter.FieldApideleteEnumGroupNameDELETE /enum_group/{name}删除某一个枚举组
TestCenter.FieldApideleteEnumGroupNameEnumNameDELETE /enum_group/{name}/{enum_name}删除具体的某一个枚举
TestCenter.FieldApideleteFieldDefinitionNameDELETE /field_definition/{name}删除某一个字段
TestCenter.FieldApigetEnumGroupGET /enum_group_list获取所有枚举组
TestCenter.FieldApigetEnumGroupNameGET /enum_group/{name}获取某一个枚举组
TestCenter.FieldApigetEnumGroupNameEnumNameGET /enum_group/{name}/{enum_name}获取具体的某一个枚举
TestCenter.FieldApigetFieldDefinitionGET /field_definition/{name}获取某一个字段的定义
TestCenter.FieldApigetFieldsGET /field_definition_list获取所有字段的定义
TestCenter.FieldApipostFieldDefinitionNamePOST /field_definition/{name}更新某一个字段
TestCenter.FieldApiputEnumGroupNameEnumNamePUT /enum_group/{name}/{enum_name}新增具体的某一个枚举
TestCenter.FieldApiputFieldDefinitionNamePUT /field_definition/{name}增加某一个字段
TestCenter.IndexApideleteIndicesIndexNameDELETE /indices/{indexName}删除索引
TestCenter.IndexApigetIndicesIndexNameGET /indices/{indexName}获取index
TestCenter.IndexApigetIndicesIndexNameDocGET /indices/{indexName}/doc/{docId}获取文档
TestCenter.IndexApigetIndicesIndexNameSearchGET /indices/{indexName}/search查询文档
TestCenter.IndexApipostIndicesIndexNamePOST /indices/{indexName}更新index
TestCenter.IndexApipostIndicesIndexNameActivePOST /indices/{indexName}/active激活Index,开始导入数据
TestCenter.IndexApipostIndicesIndexNameAppendPOST /indices/{indexName}/append刷新并追加Index的数据
TestCenter.IndexApiputIndicesIndexNamePUT /indices/{indexName}添加index
TestCenter.IndexApiputIndicesIndexNameDocDocIdPUT /indices/{indexName}/doc/{docId}更新文档
TestCenter.TableApideleteTableNameDELETE /table/{name}删除一个table
TestCenter.TableApideleteTableTableNameDefinitionTableFieldNameDELETE /table/{table_name}/definition/{table_field_name}删除某一个table的某一个字段的定义
TestCenter.TableApigetTableGET /table/{name}获取某一个table
TestCenter.TableApigetTableListGET /table_list获取所有的table
TestCenter.TableApigetTableNameDefinitionTableFieldNameGET /table/{table_name}/definition/{table_field_name}获取某一个table的某一个字段的定义
TestCenter.TableApipostTableNamePOST /table/{name}修改一个table
TestCenter.TableApipostTableTableNameDefinitionTableFieldNamePOST /table/{table_name}/definition/{table_field_name}更新某一个table的某一个字段的定义
TestCenter.TableApiputTableNamePUT /table/{name}创建一个table
TestCenter.TableApiputTableTableNameDefinitionTableFieldNamePUT /table/{table_name}/definition/{table_field_name}新增某一个table的某一个字段的定义

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: Bearer authentication
1.0.3

1 year ago

1.0.2

1 year ago

1.0.0

1 year ago