<分区>
我正在开发网络服务。客户的业务系统将使用这些网络服务与我们的系统集成。我想提供我们网络服务的文档。记录 Web 服务的最佳实践是什么？
<分区>
我正在开发网络服务。客户的业务系统将使用这些网络服务与我们的系统集成。我想提供我们网络服务的文档。记录 Web 服务的最佳实践是什么？
最佳答案
IMO 它应该接近于 WSDL 的 wsdl:documentation 元素和 XSD 的 xs:documentation 元素的源代码。尽管这对开发人员来说是一个有值(value)且可维护的解决方案，但在面向服务的环境中向业务公开服务能力并不是很好。
无论如何，对于 Java 开发人员来说，问题是 Java->WSDL with JAX-WS 不支持这些元素。
关于documentation - 如何为客户端记录 Web 服务，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/1645376/