2016-12-07 2 views
0

Я создаю RESTful API и слежу за лучшими практиками для него, и я стал с этим большим сомнением.RESTful Best Practices - Как назвать ресурс отчета

Мне нужно создать отчет (с диаграммами и таблицами данных), который он сделал для анализа других ресурсов (оценки), и многие другие параметры делают этот отчет переменной по отображаемым данным.

Итак, ища лучшие практики, я не знаю, нужно ли мне получать все данные и обрабатывать их в Javascript, чтобы сделать отчет (на стороне клиента), чтобы шаблон RESTful не был проблемой;

Или как я могу назвать ресурс «отчет», который состоит из многих других ресурсов. Мой non restful mind хочет создать /api/rest/reports/executiveReport?evaluation=:id&competences=:id&competences=:id&employee=:id uri

Как я могу достичь этого в красивой палитре url? Я не хочу обрабатывать данные в Javascript, так как есть много ошибок или исключений, которые я не могу уловить. Я предпочитаю доставлять отчет, который будет показан.

Спасибо!

+0

Я недавно что-то сделал, когда использовал основной «объект» в качестве ресурса. У меня были конечные точки, такие как '../ stats/projects' и' ../ stats/tasks'. Параметры были соответствующим образом различны. Не могли бы вы сделать что-то подобное: '../ reports/executive'? –

+0

Вы можете достичь этого, указав путь класса как/report, а затем конкретные методы для каждого типа отчета, например/executive. Таким образом, ваши API будут гибкими для каждого типа отчета. скажем, исполнительный отчет принимает 2 параметра, но какой-то другой отчет занимает 3. – k1133

ответ

1

Так я реализовал отчет конечной точки называется 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