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

时间:2016-12-07 14:29:07

标签: rest api design-patterns

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

我需要创建一个报告(包含图表和数据表),这些报告由分析其他资源(评估)组成,而许多其他参数使得此报告在显示的数据上可变。

因此,寻找最佳实践,我不知道是否需要获取所有数据,并在Javascript处理它,以生成报告(客户端),因此RESTful模式不是问题; < / p>

或者我如何命名资源&#34;报告&#34;这是由许多其他资源组成的。我的非宁静的心灵想要创建一个/api/rest/reports/executiveReport?evaluation=:id&competences=:id&competences=:id&employee=:id uri

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

谢谢!

1 个答案:

答案 0 :(得分:2)

所以我实现了一个名为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