REST风格的最佳实践 - 如何命名的报告资源

问题描述:

我创建一个RESTful API,并按照它的最佳实践,我在一个大的疑问与这成了。REST风格的最佳实践 - 如何命名的报告资源

我需要创建一个报告(用图表和数据表),即它是由分析另一资源(估计),以及许多其他PARAMS使这个报告是可变的,显示的数据。

因此,寻找最佳做法,我不知道如果我需要得到所有的数据,并对其进行处理,在JavaScript中,使报告(客户端),所以RESTful模式是没有问题的;

或者我怎么可以命名一个资源“报告”是由许多其他资源。我非宁静的心灵想要创建一个/api/rest/reports/executiveReport?evaluation=:id&competences=:id&competences=:id&employee=:id URI

我怎样才能在一个美丽的RESTful模式URI实现这一目标?我不想在Javascript中处理数据,因为有很多错误,或者我无法捕捉的异常。我更愿意提供要显示的报告。

谢谢!

+0

我已经做了一些最近在那里我主要使用的“主体”作为资源。我有像'../ stats/projects'和'../ stats/tasks'这样的端点。参数适当不同。你能不能做类似的事情:'../ reports/executive'? –

+0

您可以通过将类路径设置为/ report,然后针对每种类型的报告(如/ executive)使用特定的方法来实现此目的。 那样你的API对于每种报告类型都是灵活的。说执行报告采取2个参数,但其他一些报告需要3个。 – k1133

所以我已经实现了一个报告端点称为api/rest/report,然后我有我的三份报告:

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

和每个端点都有自己的过滤器作为params像:

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