什么是api的好路由模板?

时间:2015-11-30 07:18:04

标签: c# api

什么是良好的API路由模板?
换句话说,是否有更令人期待的模板,或者它根本不重要?

第一: “API / {控制器} / {行动} /(编号)”

http://example.com/WorkItem/details/5

第二: “API / {控制器} / {ID} / {行动}”

http://example.com/WorkItem/5/details

1 个答案:

答案 0 :(得分:1)

我认为在RESTful szenario中使用第二种方法是一种很好的做法。通用框架以这种方式处理它:

示例1:Rails

请参阅 2.2 CRUD,动词和动作中的文档,其中

GET /photos/{:id}/edit引用PhotosController s edit - 方法返回HTML表单以编辑照片

示例2:Laravel

请参阅 RESTful资源控制器中的文档,其中

GET /photo/{photo}/edit也指PhotoController s edit - 方法。

另外,请参阅下面的嵌套资源部分,它看起来更像您的用例:

Route::resource('photos.comments', 'PhotoCommentController');  以photos/{photos}/comments/{comments}的方式注册嵌套路由,这是您的用例,看起来更像是您的第二种方法。