Как я могу назвать свои API в магазине API (WSO2)? Существуют ли соглашения об именах или лучшие практики? - PullRequest
0 голосов
/ 10 апреля 2020

Я пытаюсь создать и опубликовать sh API от различных поставщиков услуг и опубликовать sh их как общее решение (в одном хранилище API). В настоящее время я пытаюсь сделать имена API простыми и описательными, например action (глагол) -onwhat (существительное) . Например, у меня есть API, который получает список FOO, я бы назвал API как List-FOO . Так просто, правда?

Но здесь возникает реальная проблема. Как я уже сказал, я делаю это для нескольких поставщиков услуг, скорее всего, у меня будет API для перечисления FOO, указывающих c и для другого поставщика услуг. Даже я думал, service_provider-action (глагол) -что (существительное) как ProviderA-List-FOO .

Но я не думаю, что это будет иметь смысл, если я захочу магазин как обычный. Есть ли что-то, чего мне не хватает, или есть лучший способ назвать API в магазине, чтобы избежать подобных проблем? Любая помощь очень заметна.

1 Ответ

1 голос
/ 11 апреля 2020

на основании данного требования я могу предложить вам определить отдельные пакеты API для каждого поставщика услуг. например, вы можете создать новый API для ProviderA и определить все службы ProviderA как пути ресурсов в этом API.

...