文章

“Refinitiv API实例” Github 群组介绍

作者:

Olivier Davant
Product Manager Product Manager

概述

我将在本文简要向您介绍路孚特(Refinitiv)API实例的Github群组。我会阐明您在该群组可以找到什么,以及如何找到这个非常有用的群组。

路孚特API实例的Github群组

该群组是由路孚特团队创建维护的,它包含为路孚特开发者社区特别创建的源代码项目板。这些项目板的用途是讲授路孚特API,以及为不同使用情况创造条件,在操作中展示这些项目板。

这些源代码项目包括:

·        与发布在路孚特开发者社区门户上的API教程有关的源代码案例

·        单独的案例应用,该应用展示了如何为基础的或更高级情况创造条件,使用一个或几个路孚特API

·        与发布在路孚特开发者社区门户上的文章有关的源代码

项目板在单独的Github代码仓库中呈现,附有READ.md文件,该文件阐明项目板的用途,提供与教程或文章有关的链接,说明如何建立运行所展示的源代码。

教程命名规则

为了更明确、更容易搜索,路孚特API实例群组教程使用以下命名规则。

教程名称由5部分组成,每部分由一个点字符“.”隔开。这种结构化命名的目的是让您快速概览每个项目板的内容。这5部分为您提供了以下标志:

  • 项目板类型:表明该项目是否与文章、案例或教程有关
  • API列表:表明该项目板中所使用的API。每个路孚特API都定义了一个简短的名称。以下为当前列表,该列表会渐渐完善:
  • ETA:企业运输API
  • EMA:企业信息API
  • EikonAPI:任何路孚特Eikon API(网页与脚本,.Net,COM)
  • AppStudio:为开发路孚特Eikon应用的AppStudio API
  • DSS:数据范畴选择API
  • RTH:路孚特报价历史API
  • RKD:路孚特知识直通车(Knowledge Direct)API
  • OpenPermID:开放永久标识符(PermID)与Calais标签API
  • RFA:稳固基础API
  • OpenDACS:开放的DACS API
  •  …

对于涉及多个API的项目板,该部分由按字母表顺序的首字母缩略词组成,并由一个破折号字符“-“隔开。

  • 编程语言:表明项目板所使用的程序语言。每个编程语言都定义了一个简短的名称。以下为当前列表,该列表会逐渐完善:
    • Cpp:C++
    • Java
    • C#
    • Javascript
    • Python
    •  …
  • 技术:可选项,表明项目板所使用的技术。以下为当前列表,该列表会随逐渐而完善:
    • COM
    • NET
    • REST
    • SOAP
    •  …
  • 项目板名称:简要描述项目板的名称

以上5部分始终会以这个特定的顺序呈现,以便您可以非常快速地直观浏览到该群组的教程。

以下为一些名称案例:

  • Tutorial.EikonAPI.Python.CompanyTearsheetEstimates
  • Example.EikonAPI.Python.NewIssuesInTheNews
  • Article.EMA.Java.ChainExpander
  • Example.EMA.Java.SpeedGuide
  • Example.AppStudio-DSS-TRTH.Javascript.SpreadSMALastIndexComponents

您可能会发现,所有这些教程都是在同一层级创建的,是一个扁平化结构。第一眼看上去可能会令人困惑,显得杂乱无章,但这是有意为之。您将会在下一部分了解到,这种与命名规则相结合的扁平化结构与Github群组的搜索教程特性给您带来的功能上非常强大的搜索便利:

如何找到这个群组?

如果您开始浏览搜索路孚特API实例Github群组,这无疑就意味着您在寻找能帮助您在工作中使用路孚特平台、API或数据的信息。那么,根据您的实际需要您可能想要从不同的角度搜索。比如,如果您正在学习API,您可能想要浏览与这个特定API有关的项目板。如果您是初学者,您可能只是对该API的教程感兴趣。如果您是比较高级的用户,您可能对使用情形的案例感兴趣。亦或者是您并没有关注任一特定的API,但您想要为偏好的程序语言或话题寻找可利用的资源。

上述命名规则、教程的扁平化结构与Github所提供的搜索教程特性的结合,让您精确地从这些不同的角度搜索。

比如,要寻找有关特定API的材料,您只需要在搜索教程栏输入该API缩写名称。下面以“EMA”举例,该示例展现了所有与Elektron信息API相关的案例、教程与文章

下面是 “EMA文章”的另一个示例,该示例仅仅展现了与Elektron信息API文章有关的教程:

正如您看到的,通过在搜索教程栏添加合适的关键词,就能很容易地缩小搜索范围。因为路孚特团队还在逐渐添加越来越多的学习材料,所以这个搜索工具将会是一个关键部件,它将会帮助您寻找恰好适合您的学习材料。

留下您的反馈意见

热烈欢迎您的反馈意见,您的反馈意见无疑能帮助我们改善。如果您喜欢这篇文章,请毫不犹豫地在下方留言或为这篇文章点赞。