Django Rest Framework的API结构

时间:2019-02-01 20:07:56

标签: api django-rest-framework

我是API构建的初学者,想仔细检查我的结构是否正确。

1)端点/文章。 GET-检索所有文章。 POST-添加新文章-正确吗?

2)端点/配置文件。 GET-检索个人资料信息授权用户。 PUT-更新个人资料信息-正确吗?

3)端点/ profile / posts。 GET-检索所有文章授权用户。是正确的,还是更好的联合端点2)和端点3)?

4)端点/ articles / GET-检索文章。 PUT-更新文章。正确吗?

也许有什么一般性建议吗?

1 个答案:

答案 0 :(得分:0)

端点结构实际上不应该取决于用户是否被授权。因此,我看不出3和1之间的区别。如果要检索给定用户的文章,则在REST结构中,它应该为/profile/<profile_id>/articles。如果要为当前登录的用户检索文章而不提供ID,那么您可能会遇到类似/articles/mine/的情况。这可以通过向文章视图集添加自定义mine操作来实现。

第一个端点和第四个端点之间有什么区别?只是斜线?如果要根据您的描述将其用作详细信息端点,则应为/article/<article_id>