有没有人能推荐Web服务的高级文档指南?
本文档应该允许对特定Web服务一无所知的人对其存在的原因、路线图和使用示例有一个基本的了解。
这样的文档应该适合在A4/Letter纸的两面打印,并且阅读时间不超过10分钟。
请注意,这是对开发人员用来使用接口的低级API文档的补充。
发布于 2009-05-01 11:12:05
我不确定我是否有指导方针,但我可以向您展示我发现的web服务API的一组很好的文档的示例。
http://www.flickr.com/services/api/
Flickr API页面以非常易读的形式列出。这个页面基本上有:
<>F210分组
特别是,描述常见访问模式的页面(上传照片、替换照片)对我来说至关重要。它们向API的使用者展示了如何做一些常见的事情,以及您希望人们如何使用您的API。最后一点很重要-你想说“嘿,我们希望你这样调用我们,使用这些方法,使用这种错误处理”。向您的用户展示一些有关API使用的最佳实践,您将节省大量的支持调用。
https://stackoverflow.com/questions/810956
复制相似问题