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 athena_core_apis 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 AthenaCoreApis = require('athena_core_apis');


var api = new AthenaCoreApis.AccountApi()
var opts = {
  'generateVerificationRequest': new AthenaCoreApis.GenerateVerificationRequest() // {GenerateVerificationRequest} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.generateVerification(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/api/v1

Class	Method	HTTP request	Description
AthenaCoreApis.AccountApi	generateVerification	POST /account/verification	生成验证码
AthenaCoreApis.AccountApi	getAccount	GET /account	查询账户信息
AthenaCoreApis.AccountApi	login	POST /account/session	用户登录
AthenaCoreApis.AccountApi	loginOptions	OPTIONS /account/session	用户登录说明
AthenaCoreApis.AccountApi	logout	DELETE /account/session	用户退出
AthenaCoreApis.AccountApi	signup	POST /account	用户注册
AthenaCoreApis.AccountApi	updateAccount	PUT /account	更改账户信息
AthenaCoreApis.AccountApi	updatePassword	PUT /account/password	更新账号密码
AthenaCoreApis.AccountApi	updatePhone	PUT /account/phone	更新绑定手机号
AthenaCoreApis.BuyPayApi	cancelOrder	DELETE /orders/{id}	取消订单
AthenaCoreApis.BuyPayApi	createOrder	POST /orders	创建订单
AthenaCoreApis.BuyPayApi	createPayment	POST /orders/{id}/payment	支付订单
AthenaCoreApis.BuyPayApi	getOrder	GET /orders/{id}	查询订单
AthenaCoreApis.BuyPayApi	listOrders	GET /orders	枚举订单
AthenaCoreApis.BuyPayApi	listTiers	GET /tiers	查询产品可购套餐
AthenaCoreApis.WeChatApi	createWechatSession	POST /wechat/session	创建微信认证会话
AthenaCoreApis.WeChatApi	getWechatSession	GET /wechat/session/{id}	查询微信认证会话详情和状态

Type: Bearer authentication (JWT)

athena_core_apis

athena_core_apis

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

BearerAuth