首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >Web服务的文档标准/结构/样式

Web服务的文档标准/结构/样式
EN

Stack Overflow用户
提问于 2009-05-01 10:44:00
回答 1查看 1.8K关注 0票数 1

有没有人能推荐Web服务的高级文档指南?

本文档应该允许对特定Web服务一无所知的人对其存在的原因、路线图和使用示例有一个基本的了解。

这样的文档应该适合在A4/Letter纸的两面打印,并且阅读时间不超过10分钟。

请注意,这是对开发人员用来使用接口的低级API文档的补充。

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2009-05-01 11:12:05

我不确定我是否有指导方针,但我可以向您展示我发现的web服务API的一组很好的文档的示例。

http://www.flickr.com/services/api/

Flickr API页面以非常易读的形式列出。这个页面基本上有:

  • 链接到概述页面
  • 常见方案的编写(在此实例中是上传照片)
  • 有关使用
  • 接口的工具的信息每种应用编程接口方法的详细说明,按活动

<>F210分组

特别是,描述常见访问模式的页面(上传照片、替换照片)对我来说至关重要。它们向API的使用者展示了如何做一些常见的事情,以及您希望人们如何使用您的API。最后一点很重要-你想说“嘿,我们希望你这样调用我们,使用这些方法,使用这种错误处理”。向您的用户展示一些有关API使用的最佳实践,您将节省大量的支持调用。

票数 4
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/810956

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档