我们正在构建一个RESTful API,它主要返回JSON格式的响应。大多数资源还会根据是否存在查询参数“回调”来有条件地将响应包装在JSONP格式中。
我的问题是,“我们应该用'.js'结束我们的端点名称,因为它们是JSON吗?”
通常,webservices不以文件扩展名结尾。但是,如果我们将URL视为静态资源(通过动态生成)而不是服务,那么给出端点文件扩展名是有意义的。
这样做会改变什么吗?它以任何方式有益或有害吗?
提前致谢。
答案 0 :(得分:3)
这可能主要取决于个人品味,但我不建议这样做,特别是如果你有面向公众的API。
出于某种原因,如果我看到的文件扩展名不是众所周知的动态生成内容(例如.php
,.jsp
,.cgi
等),我倾向于假设它是一个静态文件,所以我可能错误地认为我可以缓存它或将其视为静态内容。一组好的文档可能会让事情变得清晰,但是给它一个.js
扩展可能会让其他开发人员感到困惑。
此外,@ user2864740对标准和其他内容留下了很好的评价。我希望我对这些答案的结尾有更多了解,所以请阅读他的贡献。