99voices_npm_profiles_client 中文文档教程
Profiles Client
该软件包包含配置文件服务的客户端。 它建立在事实上返回一个实例 swagger-js 的。 深入概述 这个包返回的对象的api，见文档 swagger-js 的。
Development
这个包是在 docker 容器中开发的。 运行scripts/run.sh获取 开发环境。 通过容器运行每个纱线操作 docker exec -it ${container_id} yarn ...。 容器监视文件更改 来源并自动重建分发代码。 在运行 yarn publish 之前 请务必运行 yarn login。
Usage
这个包包含并返回一个单例。 这意味着您可以要求 文件随处可见，您将始终获得相同的客户端实例。 为了让它工作，首先初始化客户端实例是至关重要的。 这是一个异步过程，是这样完成的：
import Config from '99voices_npm_config';
import Client from '99voices_npm_profiles_client';
let config = Config();
const token = "x.y.z"; // should be obtained via the 99voices_npm_authentication_client -> login
console.log(config.get('RECORDINGS_CLIENT_SPEC_URL')) // 'http://tyk:8080/profiles/1.0.0/spec.yaml' => the url the client should fetch the spec from and will be build based on
Client({config,token}).then( client => { ... }).catch( err => { ... })
Initialization
这个包使用了 swagger-js 的构造函数。 构造函数 Client({config, token, options, purge}) 将 options 传递给 大摇大摆的构造函数。 请参阅 swagger-js 对该对象的深入概述。 purge 属性可以设置为 true 强制重新获取规范并重建客户端，即使已经有一个。 客户端初始化后，这个包也会修补它的basePath 直接使用。 它假定当规范位于“http://tyk:8080/profiles/1.0.0/spec.yaml”时， API 的 basePath 将为“http://tyk:8080/profiles/1.0.0/”
Profiles Client
This package contains a client for the profiles service. It is build on, and defacto returns an instance of swagger-js. For an in depth Overview of the api of the object returned by this package, see the documentation of swagger-js.
Development
This package is developed within a docker container. Run scripts/run.sh to obtain the development environment. Run every yarn operation through the container like docker exec -it ${container_id} yarn .... The container watches for file changes on the sources and automatically rebuilds the distribution code. Before running yarn publish be sure to run yarn login.
Usage
This package contains and returns a singleton. Meaning that you can require the file wherever you want to, and you will always obtain the same client instance. In order for this to work it is vital that the client instance is first initialized. This is an asynchronous process and done like this:
import Config from '99voices_npm_config';
import Client from '99voices_npm_profiles_client';
let config = Config();
const token = "x.y.z"; // should be obtained via the 99voices_npm_authentication_client -> login
console.log(config.get('RECORDINGS_CLIENT_SPEC_URL')) // 'http://tyk:8080/profiles/1.0.0/spec.yaml' => the url the client should fetch the spec from and will be build based on
Client({config,token}).then( client => { ... }).catch( err => { ... })
Initialization
This package uses the constructor of swagger-js. The constructor Client({config, token, options, purge}) passes the options on to the swagger constructor. See swagger-js for an in depth overview of this object. The purge attribute can be set to true which forces to refetch the spec and rebuild the client, even if there is one already. After the client is initialized, this package will also patch its basePath for direct use. It assumes that when the spec is at 'http://tyk:8080/profiles/1.0.0/spec.yaml', the basePath of the API will be 'http://tyk:8080/profiles/1.0.0/'
