用于仅从资源获取列的URL命名约定

Question

我有一个微服务端点，可以从数据库中获取公司详细信息列表。 URL模式如下所示。

GET https://example.com/api/v1/companies

我需要开发另一个URL，只从DB中获取公司名称。我知道我可以重用相同的URL，但是只获取一列我不想获取所有列。

请指导我如何获得此案例的网址格式。

例如：GET https://example.com/api/v1/companies/companyNames？

Answer 1

在真正需要之前，我们不应该增加暴露的服务数量。我建议重新使用相同的服务格式：

GET https://example.com/api/v1/companies?col=name

如果col参数为空，则可以假定返回所有列。这将帮助您重用代码库;微小的变化;并具有很大的灵活性;并减少对最终消费者的困惑。