RESTful API URL结构化

时间:2013-01-23 04:37:00

标签: php api url rest laravel

我很困惑我应该如何构建我正在开发的RESTful API的URL。 我的问题来自这样一个事实,即有时我需要从一次调用中获得几个连接表。

在一个例子中,我需要得到两张桌子。我有一个名为courses的表和一个名为topics的表。我需要获取course_name行,然后获取属于该课程的所有主题。

在另一个例子中,我需要获得三个表。我需要将topics加入partsbullet_points

我应该如何在网址中引用这些内容?

它应该是这样的吗? 获得一门课程:

courses/:course_id/ 

获得课程及其主题:

courses/:course_id/topics

获取主题及其部分及其要点:

courses/:course_id/topics/:topic_id/parts

我是新手,所以我想知道我应该如何真正接近网址的结构。

1 个答案:

答案 0 :(得分:2)

我认为您建议的网址结构很好。它也很好地与良好的资源布局相对应。

// courses
$list = $model->getCourseList();

// courses/c_id
$course = $model->getCourse($c_id);

    // courses/c_id/topics
    $courseTopicList = $course->getTopicList();

    // courses/c_id/topics/t_id
    $courseTopic = $course->getTopic($t_id);

        // courses/c_id/topics/t_id/parts
        $courseTopicParts = $topic->getParts();