RESTful 最佳实践 - 如何命名报表资源

标签 rest api design-patterns

我正在创建一个 RESTful API 并遵循它的最佳实践,但我对此产生了很大的怀疑。

我需要创建一个报告(包含图表和数据表),该报告由分析其他资源(评估)组成,并且许多其他参数使该报告根据显示的数据而变化。

因此,在寻找最佳实践时,我不知道是否需要获取所有数据,并在 Javascript 中对其进行处理,以制作报告(客户端),因此 RESTful 模式不是问题;

或者我如何命名由许多其他资源组成的资源“报告”。我不平静的头脑想要创建一个 /api/rest/reports/executiveReport?evaluation=:id&competences=:id&competences=:id&employee=:id uri

如何在漂亮的 RESTful 模式 uri 中实现这一目标?我不想在 Javascript 中处理数据,因为有很多错误或我无法捕获的异常。我更喜欢提交要显示的报告。

谢谢!

最佳答案

因此,我实现了一个名为 api/rest/report 的报告端点,然后我得到了三个报告:

  • api/rest/report/executive
  • api/rest/report/detailed
  • api/rest/report/datatable

每个端点都有自己的过滤器作为参数,例如:

api/rest/report/executive?uuid=12345&competences=65424&competences=454124&comparativeGroup=12354&comparativeGroup=98457

关于RESTful 最佳实践 - 如何命名报表资源,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/41020027/

相关文章:

java - 是否可以在没有 @DirtiesContext 的情况下测试 Spring REST Controller ?

node.js - 我们如何在从 UI 传递到后端服务器时隐藏身份验证凭据等信息?

java - JSON 中的阿拉伯字符

php - 在 Freebase 中检索/存储所有相关的 Actor

python - 更新 Django 数据库 - 脚本

entity-framework - EF/Silverlight 应用程序的项目结构

node.js - 从 API 响应中打开 PDF 到 Angular 中的新选项卡

api - 如何使用 Slack API 发送 "@here"?

java - Java 栈和递归

c# - 静态类和单例类设计模式有什么区别?