2013-04-11 61 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等一些例子)

有了这些信息,您基本上可以呈现服务的所有功能,而无需解释与代码相关的东西。