Преобразуйте JSON в Codable struct Swift!

Введите JSON, чтобы получить код Codable struct на Swift, включая вложенные объекты! Поддержка: Codable, CodingKeys, JSONDecoder, iOS.
JSON
Результат
 

Преобразуйте JSON в Codable struct Swift!

Преобразует JSON в struct на Swift, реализующие Codable. Свойства объявляются через let и переименовываются в camelCase, а enum CodingKeys генерируется только для тех структур, где имя отличается от ключа JSON.

Используйте, когда приложению для iOS или macOS нужна модель для декодирования ответа URLSession через JSONDecoder или когда нужны типы, совпадающие с mock-JSON для превью SwiftUI.

Как пользоваться

  1. Вставьте тело ответа вашего API, например перехваченное через Proxyman или Charles.
  2. Укажите в Имя типа имя структуры верхнего уровня (например, EpisodePage).
  3. Вставьте результат в Swift-файл; import Foundation включён.
  4. Декодируйте через try JSONDecoder().decode(EpisodePage.self, from: data).

Пример

Вход (JSON)
{
  "podcast": "Swift Talk",
  "episodes": [
    { "id": 301, "title": "Async Sequences", "duration": 1840, "explicit": false },
    { "id": 302, "title": "Macros", "duration": 2215.5, "explicit": false, "guest_name": "Chris" }
  ],
  "total_count": 2
}
Результат (Swift · Codable)
import Foundation

struct EpisodePage: Codable {
    let podcast: String
    let episodes: [Episode]
    let totalCount: Int

    enum CodingKeys: String, CodingKey {
        case podcast
        case episodes
        case totalCount = "total_count"
    }
}

struct Episode: Codable {
    let id: Int
    let title: String
    let duration: Double
    let explicit: Bool
    let guestName: String?

    enum CodingKeys: String, CodingKey {
        case id
        case title
        case duration
        case explicit
        case guestName = "guest_name"
    }
}

Элементы массива episodes становятся структурой Episode. duration смешивает целое (1840) и дробное (2215.5), поэтому это Double; guest_name, найденный только во втором эпизоде, — guestName: String?. Любая структура с переименованным полем получает enum CodingKeys со всеми своими ключами.

Возможности

  • Каждая структура реализует Codable; свойства — неизменяемые let.
  • Ключи в snake_case и kebab-case становятся свойствами в camelCase, и только тогда добавляется enum CodingKeys: String, CodingKey с исходными ключами.
  • Типы: String, Int, Double, Bool и [T] для массивов.
  • Поля, отсутствующие в части элементов или содержащие null, становятся Optional (String?), так что отсутствующие ключи тоже декодируются.
  • Значения смешанного типа используют сгенерированный декодируемый enum JSONValue.
  • Ключевые слова Swift вроде default, class или self заключаются в обратные кавычки.
  • Массив верхнего уровня даёт typealias Root = [RootItem].

Сценарии использования

URLSession с async/await

По одному примеру ответа вы получаете модель, которую можно декодировать прямо в следующей строке после let (data, _) = try await URLSession.shared.data(from: url).

Экраны со списками на SwiftUI

Добавьте сгенерированной структуре Identifiable (если у неё есть поле id) и передайте её прямо в List(page.episodes) { ... }.

Встроенные mock-данные

Положите пример JSON с этапа дизайна в бандл приложения и декодируйте его той же моделью — экраны можно собирать ещё до готовности реального API.

Примечания и ограничения

  • Строки с датами выводятся как String. Чтобы получить Date, смените тип свойства и задайте стратегию вроде decoder.dateDecodingStrategy = .iso8601.
  • Если в ответе нет ключа необязательного по типу свойства, декодирование выбросит DecodingError.keyNotFound. Добавьте ? к полям, которые API может опускать, даже если в вашем примере они всегда были.
  • Все свойства — let; для моделей, которые вы изменяете как состояние view, переключитесь на var.
  • Дополнительные протоколы вроде Identifiable или Hashable не добавляются.
  • Enum JSONValue — вспомогательный код для смешанных типов; если в проекте уже есть эквивалентный тип, удалите его и используйте свой.

Частые вопросы

С keyDecodingStrategy = .convertFromSnakeCase можно удалить CodingKeys?

Да, тогда декодер сам преобразует guest_name ↔ guestName. Но не совмещайте оба подхода: декодер сначала переводит ключи в camelCase, а потом сравнивает их с raw value "guest_name" в CodingKeys, и сопоставление не срабатывает.

Почему структуры, а не классы?

Обращаться с моделями ответов как с типами-значениями — обычное соглашение Swift, а структуры бесплатно получают поэлементный инициализатор, что упрощает создание тестовых данных. Если нужна ссылочная семантика, смените на final class и добавьте инициализатор.

Поле, которое я ожидал целым, вышло Double.

Когда ключ содержит и целые, и дробные, Double позволяет не потерять точность. И наоборот: если все значения в примере выглядят как 4.0, JSON-парсер браузера читает их как целые, и может получиться Int, так что сверьтесь с реальными значениями API.

Сохраняются ли исходные ключи при обратном кодировании в JSON?

CodingKeys используются и при кодировании, так что JSONEncoder снова запишет guest_name. Optional-свойства со значением nil в вывод не попадают.