2009-02-05 63 views
3

我在一個長期項目中領導一個同學的程序員團隊這個學期(足夠長的時間我可以在完成之前畢業)。我曾在ICD的實習崗位上工作過,但並非團隊中的每個人都有過這方面的經歷,而且由於保密協議,我無法向他們展示我所從事的文件。接口控制文檔示例?

任何人都可以提供「真實世界」界面控制文件的鏈接嗎?我可以自己想出一些玩具的例子,但我想將這些文檔展示給他們最有用的。

我們ICD的主要重點將是不同硬件組件的互操作性,但歡迎所有形式的ICD。

回答

-1

知識OBJECTS WEB SERVICE 接口控制文件

視覺:爲了提供給刪節(私人信息) 應用需要訪問比索數據層支持。

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

  1. 獲取密鑰由時間範圍 摘要:HTTP://:/ knowledge_objects /鍵/ {開始}/{端} 實施例:http://localhost:8080/knowledge_objects/keys/2009-10-27/2010-01-01

示例返回:

<Keys> 
    <DocumentID>200800000009</DocumentID> 
    <DocumentID>200800000010</DocumentID> 
    <DocumentID>200800000011</DocumentID> 
    <DocumentID>200800000012</DocumentID> 
    <DocumentID>200800000217</DocumentID> 
    <DocumentID>200800000001</DocumentID> 
</Keys> 
  1. 通過編號獲取知識對象 摘要:HTTP://:/ knowledge_objects/{DOC_ID} 例如:http://:/ knowledge_objects/200910273200 示例返回:

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

+0

上面僅僅是一個簡單的RESTful我三年前建立的Web服務。這是我第一次刺入ICD。這非常重要且非常有用,因爲它讓我(Web服務構建者)和客戶端(Web服務用戶)能夠事先明確界定邊界(操作/結果)。然後我們開始編碼,整合接近無縫。 – wayneseymour 2011-08-24 21:10:29