https://github.com/devgregw/swift-geojson

A simplisitic and cross-platform GeoJSON implementation in pure Swift
https://github.com/devgregw/swift-geojson

Last synced: 29 days ago
JSON representation

A simplisitic and cross-platform GeoJSON implementation in pure Swift

• Host: GitHub
• URL: https://github.com/devgregw/swift-geojson
• Owner: devgregw
• License: mit
• Created: 2024-08-25T03:43:30.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-12-12T01:08:50.000Z (about 1 month ago)
• Last Synced: 2025-12-13T06:37:11.557Z (about 1 month ago)
• Language: Swift
• Size: 36.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# swift-geojson [![Swift](https://github.com/devgregw/swift-geojson/actions/workflows/swift.yml/badge.svg)](https://github.com/devgregw/swift-geojson/actions/workflows/swift.yml) [![CodeQL Analysis](https://github.com/devgregw/swift-geojson/actions/workflows/codeql.yml/badge.svg)](https://github.com/devgregw/swift-geojson/actions/workflows/codeql.yml)

`swift-geojson` is a simplisitic and cross-platform GeoJSON implementation in pure Swift and is largely based on [RFC 7946](https://datatracker.ietf.org/doc/html/rfc7946).

## Motifivation

`swift-geojson` is used in my repo [Redzone](https://github.com/devgregw/Redzone) to parse GeoJSON data from the National Weather Service. While MapKit provides [MKGeoJSONDecoder](https://developer.apple.com/documentation/mapkit/mkgeojsondecoder), it is unavailable on watchOS. My implementation is intended to provide a more Swifty syntax such as enums with associated values.

## Limitations

- `Feature` properties are currently coerced to strings.

- `bbox` and `crs` are currently not parsed.

- Foreign members as [defined in the RFC](https://datatracker.ietf.org/doc/html/rfc7946#section-6.1) are not currently parsed.

## Installation

Add `swift-geojson` with Swift Package Manager as you would any other package and import `GeoJSON`.

## Usage

Create an instance of `GeoJSONDecoder` and call `decode(_:from:)` with your GeoJSON `Data`. Since `GeoJSONDecoder` is a subclass of `JSONDecoder`, the existing `decode` functions still exist and are usable; however, the GeoJSON models provided in this package expect to be decoded by a `GeoJSONDecoder`. To simplify the call site, a `GeoJSONDecoder` contains an overload `decode(_:from:)` where the type argument is defaulted to `GeoJSONObject.self`. In practice, this function is called like `try GeoJSONDecoder().decode(from: myData)`. The decoder will return a case of `GeoJSONObject` corresponding to the top-level JSON object in the provided data. If the top-level type is a geometry object such as `Point` or `LineString`, the decoder will return `GeoJSONObject.geometry` with the the relevant geometry model provided in the associated value. `GeoJSONObject` contains two computed helper variables: `features` and `geometries`. `features` returns the provided array of features when `self` is `.featureCollection`. When `self` is `.feature`, `features` will return a single-element array containing the provided feature. Likewise, `geometries` works the same for the `.geometryCollection` and `.geometry` cases.