Соглашение об именовании URL для извлечения только столбца из ресурса

Question

У меня есть конечная точка микросервиса, которая получает список данных компании из БД. Шаблон URL выглядит следующим образом.

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

Мне нужно разработать еще один URL, который выбирает только названия компаний из БД. Я понимаю, что могу использовать один и тот же URL, но для извлечения только одного столбца я не хочу извлекать все столбцы.

Пожалуйста, объясните мне, как создать шаблон URL для этого случая.

Пример: GET https://example.com/api/v1/companies/companyNames?

Answer 1

Мы не должны увеличивать количество предоставляемых услуг, пока они действительно не понадобятся. Я рекомендую повторно использовать тот же сервис в формате:

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

Если параметр col не указан, вы можете вернуть все столбцы. Это поможет вам повторно использовать кодовую базу; минимальные изменения; и много гибкости в будущем; и меньше путаницы для конечного потребителя.