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

Question

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

获取https://example.com/api/v1/companies

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

请指导我如何使用此案例的 url 模式。

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

Answer 1

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

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

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