2013-04-11 67 views
0

我正在嘗試設計一個web服務。如何表示web服務設計

我通常只是在白板上劃出一些想法並給我的經理提供高級設計之後,就深入瞭解這些事情。但是,現在我需要將我的想法呈現給分析師和其他技術類型,我希望儘可能清楚地傳達它。

我心裏有一個Web服務,我知道一切就會觸動的系統和我想如何構建它並揭露它...

一個Oracle數據庫爲後臺,我將使用一個無狀態的會話bean(以WAS 7.0作爲容器),我將爲那些好奇的人公開一個rest-full和soap節點給客戶端(特別是JAX-RS和JAX-WS)。

......但是我想用高層次的方式來表現。我不想陷入雜草並展示類圖,但我希望稍微詳細一點,而不是組織圖提供的細節。

我正在考慮只是採取組件圖的一個子集(只是web服務),並製作一個組件圖。這似乎是最合乎邏輯的事情。但是我只是想知道,在類圖和組件圖之間是否存在一箇中間地帶,它將顯示Web服務的所有部分,但不一定代表將要在系統中使用的每個類。

回答

1

我真的不設計Web服務,但我最近編寫了它們。也許你可以包括有關Web服務的以下信息:

  • 用於Web服務的URL格式
  • 所有該服務將處理及其 相應的響應(GET,POST,PUT,DELETE可用的請求)
  • 的請求/響應身體參數
  • 的MIME類型的服務將消耗並且以特定 請求/響應產生
  • 提供的請求和響應(JSON,XML等一些例子)

有了這些信息,您基本上可以呈現服務的所有功能,而無需解釋與代碼相關的東西。