接口控制文档示例?

时间:2009-02-05 05:51:09

标签: api documentation interface

我正在这个学期领导一个学生程序员团队参与一个长期项目(足够长的时间,我可以在完成之前毕业)。我和ICD一起在实习期间工作过,但团队中并不是每个人都有这种经历,而且由于保密协议,我无法向他们展示我合作过的文件。

任何人都可以提供“真实世界”界面控制文档的链接吗?我可以自己想出一些玩具示例,但我想展示这些文件最有用的。

我们ICD的主要重点是不同硬件组件的互操作性,但欢迎所有形式的ICD。

1 个答案:

答案 0 :(得分:-1)

知识对象WEB服务 界面控制文件

愿景:为删除(私人信息)提供数据层支持 需要访问比索的应用程序。

http://localhost:8080/knowledge_objects/application.wadl 返回Web应用程序描述语言(WADL)页面,其中包含有关knowledge_objects方法的信息。

  1. 按日期范围获取密钥 摘要:http://:/ knowledge_objects / keys / {start} / {end} 示例:http://localhost:8080/knowledge_objects/keys/2009-10-27/2010-01-01
  2. 返回示例:

    <Keys> 
      <DocumentID>200800000009</DocumentID> 
      <DocumentID>200800000010</DocumentID> 
      <DocumentID>200800000011</DocumentID> 
      <DocumentID>200800000012</DocumentID> 
      <DocumentID>200800000217</DocumentID> 
      <DocumentID>200800000001</DocumentID> 
    </Keys> 
    
    1. 按ID 获取知识对象 摘要:http://:/ knowledge_objects / {doc_id} 示例:http://:/ knowledge_objects / 200910273200 示例返回:

      <?xml version="1.0" encoding="ISO-8859-1"?> <Report> <Documents>
      *REDACTED (private information)* </Report> </Documents>