6aika-paatos-client 中文文档教程

Question

6aika-paatos-client

6aikaPaatosClient - 6aika-paatos-client 的 JavaScript 客户端 用于分发有关决策和决策背后人员的数据的 API 此 SDK 由 Swagger Codegen 项目自动生成：

• API version: 0.0.5
• Package version: 0.0.1
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

将库发布为 npm, 请按照“发布npm包”中的步骤进行操作。

然后通过以下方式安装它：

npm install 6aika-paatos-client --save

Local development

要在本地使用库而不发布到远程 npm 注册表，首先通过更改安装依赖项 进入包含 package.json（和本自述文件）的目录。 我们称它为 JAVASCRIPT_CLIENT_DIR。 然后运行：

npm install

接下来，在 npm 中全局链接它，使用以下内容，同样来自 JAVASCRIPT_CLIENT_DIR：

npm link

最后，切换到你想要使用 6aika-paatos-client 的目录，然后运行：

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

你现在应该能够在你目录中的 javascript 文件中 require('6aika-paatos-client')跑到最后 上面的命令来自。

git

# 如果库托管在 git 存储库中，例如 https://github.com/GITUSERID/GITREPOID 然后通过以下方式安装：

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

该库还可以通过 npm 和 browserify 在浏览器环境中运行。 关注后 使用 Node.js 执行上述步骤并使用 npm install -g browserify 安装 browserify， 执行以下操作（假设 main.js 是您的入口文件，也就是说您实际所在的 javascript 文件 使用这个库）：

browserify main.js > bundle.js

然后在 HTML 页面中包含 bundle.js。

Webpack Configuration

使用 Webpack 您可能会遇到以下错误：“找不到模块：错误： 无法解析模块”，当然你应该禁用 AMD 加载器。添加/合并 您的 webpack 配置的以下部分：

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

请按照 安装 指令并执行以下 JS 代码：

var 6aikaPaatosClient = require('6aika-paatos-client');

var api = new 6aikaPaatosClient.ActionsApi()

var opts = { 
  'limit': 56, // {Number} Specify the number of element to display per page.
  'offset': 56 // {Number} Specify the offset to start displaying element on a page.
};
api.actionsList(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

所有 URI 都相对于 https://paatos-test.6aika .fi/v1

Class	Method	HTTP request	Description
6aikaPaatosClient.ActionsApi	actionsList	GET /action/	Retrieve a list of actions
6aikaPaatosClient.ActionsApi	actionsRetrieve	GET /action/{id}/	Retrieve a single video by ID
6aikaPaatosClient.CasesApi	casesList	GET /case/	Retrieve a list of cases
6aikaPaatosClient.CasesApi	videoDetail	GET /case/{id}/	Retrieve a single case video by ID
6aikaPaatosClient.Decision_makersApi	membershipsList	GET /membership/	Retrieve a list of memberships
6aikaPaatosClient.Decision_makersApi	membershipsRetrieve	GET /membership/{id}/	Retrieve a single membership record
6aikaPaatosClient.Decision_makersApi	organizationsList	GET /organization/	Retrieve a list of organizations
6aikaPaatosClient.Decision_makersApi	organizationsRetrieve	GET /organization/{id}/	Retrieve a single person record
6aikaPaatosClient.Decision_makersApi	personsList	GET /person/	Retrieve a list of persons
6aikaPaatosClient.Decision_makersApi	personsRetrieve	GET /person/{id}/	Retrieve a single person record
6aikaPaatosClient.Decision_makersApi	postsList	GET /post/	Retrieve a list of posts
6aikaPaatosClient.Decision_makersApi	postsRetrieve	GET /post/{id}/	Retrieve a single post record
6aikaPaatosClient.MembershipsApi	membershipsList	GET /membership/	Retrieve a list of memberships
6aikaPaatosClient.MembershipsApi	membershipsRetrieve	GET /membership/{id}/	Retrieve a single membership record
6aikaPaatosClient.OrganizationsApi	organizationsList	GET /organization/	Retrieve a list of organizations
6aikaPaatosClient.OrganizationsApi	organizationsRetrieve	GET /organization/{id}/	Retrieve a single person record
6aikaPaatosClient.PersonsApi	personsList	GET /person/	Retrieve a list of persons
6aikaPaatosClient.PersonsApi	personsRetrieve	GET /person/{id}/	Retrieve a single person record
6aikaPaatosClient.PostsApi	postsList	GET /post/	Retrieve a list of posts
6aikaPaatosClient.PostsApi	postsRetrieve	GET /post/{id}/	Retrieve a single post record

Documentation for Models

• 6aikaPaatosClient.Action
• 6aikaPaatosClient.Area
• 6aikaPaatosClient.Attachment
• 6aikaPaatosClient.CaseRelatedCases
• 6aikaPaatosClient.CaseSummary
• 6aikaPaatosClient.CaseTitle
• 6aikaPaatosClient.Content
• 6aikaPaatosClient.ContentHypertext
• 6aikaPaatosClient.Event
• 6aikaPaatosClient.InlineResponse200
• 6aikaPaatosClient.InlineResponse2001
• 6aikaPaatosClient.InlineResponse2002
• 6aikaPaatosClient.InlineResponse2003
• 6aikaPaatosClient.InlineResponse2004
• 6aikaPaatosClient.InlineResponse2005
• 6aikaPaatosClient.Membership
• 6aikaPaatosClient.Meta
• 6aikaPaatosClient.ModelCase
• 6aikaPaatosClient.Organization
• 6aikaPaatosClient.Person
• 6aikaPaatosClient.Post
• 6aikaPaatosClient.VoteCount
• 6aikaPaatosClient.VoteEvent

Documentation for Authorization

所有端点都不需要授权。