php API端点的命名约定

6ovsh4lw 于 2023-02-21 发布在 PHP

关注(0)|答案(1)|浏览(86)

我已经创建了端点来检索活动的引用。但是，我对路线名称的一致性有疑问。
就我而言，我有：

// retrieves all quotes for a business, specifically for the indicated business type
GET api/businesses/{uuid}/business-types/{uuid}/quotes

// retrieves a quote by uuid
GET api/quotes/{uuid}

// creates a quote
POST api/quotes

// updates a quote
PATCH api/quotes/{uuid}

正如您所看到的，点1中的路由始终与同一资源族相关，但具有不同的路由名称。我不确定这是否正确，以及它是否应该具有相同的前缀。

php

来源：https://stackoverflow.com/questions/75507407/naming-conventions-for-api-endpoints

1条答案

按热度按时间

0g0grzrc1#

在为您的路由命名方面没有标准，但在您的情况和类似的情况下，如果您为属于同一组的路由使用前缀，并且方法指向其功能，则会是首选
例如：
获取x1月1x
术后api/quotes/create
贴片api/quotes/update/{uuid}
使用quotes作为前缀，您的路由也应该类似于QuotesController示例

Route::controller(QuotesController::class)->prefix('quotes')->group(function () {
    Route::get("/get/{uuid}", 'get');
    Route::post("/create", 'create');
    Route::patch("/update/{uuid}", 'update');
 
});

赞(0）回复(0）举报 2023-02-21

我来回答

php API端点的命名约定

1条答案

相关问题

热门标签

最新问答