Как написать тип из двух слов в JSON: API? - PullRequest
Новая
       28

Как написать тип из двух слов в JSON: API?

0 голосов
/ 28 марта 2019

Я хочу опубликовать инопланетный артефакт на моем сервере.

Должен ли я написать type = "alienArtifact"

или type = "Alien-Artifact"

или что-то совсем другое?

Я посмотрел здесь https://jsonapi.org/format/, но имеет дело только с простыми типами, "объектами".

1 Ответ

2 голосов
/ 01 апреля 2019

JSON: спецификация API является независимой, если вы используете kebab-case, snake_case или camelCase для имен полей, но поставляется с рекомендацией :

Имена членовДОЛЖЕН быть в верблюжьей шкуре (то есть wordWordWord)

Эта рекомендация была изменена в октябре 2018 года. Ранее она была kebab-case.Поэтому многие статьи о JSON: спецификации API и документация для библиотек все еще используют kebab-case.Эти аргументы были приведены в качестве основных причин этого изменения:

  • Имена CamelCased могут использоваться непосредственно в качестве идентификаторов почти во всех языках программирования, что облегчает начало работы с json: api иработать с течением времени.Дашеризованные имена можно использовать в качестве идентификаторов в основном только в Лиспе.

  • CamelCased имена являются наиболее распространенным соглашением в сообществе JS, а JS является крупнейшим пользователем JSON: API

  • Имена CamelCased немного короче, чем имена, выделенные заштрихованными (или змеиными) именами, что может помочь с ограничением символов в URL в случае сложных фильтров или других типов сложных запросов (например, некоторые GraphQL, например, «глубокий»опроса »), которые мы могли бы сериализовать в URL в будущем.

Подробнее об этом изменении можно узнать в соответствующем запросе на получение .

...