-
Notifications
You must be signed in to change notification settings - Fork 1
Versioning and Roadmap
Semantic Versioning. From 1.0.0 the public API is stable: major for a
breaking change, minor for additions, patch for fixes. Types behind
@_spi(SwiftNetworkKitTesting) are not covered by this guarantee.
Releases are automated: every merge to main updates a rolling release pull request (version bump
plus a CHANGELOG.md section generated from the Conventional Commit
history). Merging that pull request tags vX.Y.Z and publishes a GitHub Release. See
CHANGELOG.md and CONTRIBUTING.md in the repo.
See CONTRIBUTING.md. Questions go to
Discussions; bugs and accepted
features use the issue templates. Non-trivial changes are discussed before a pull request. By
submitting a PR you assign it to the Owner (LICENSE Section 4).
In short: zero dependencies, one primary type per file, Swift 6 strict concurrency, Conventional
Commits, and every change stays green under swift build -warnings-as-errors, swift test,
ThreadSanitizer, SwiftLint --strict, and swift format lint --strict.
swift build -Xswiftc -warnings-as-errors
swift test --parallel
swift test --sanitize=thread
swiftlint --strict
swift format lint -r -s --configuration .swift-format Sources Tests
bash scripts/coverage.sh1.0 shipped with the public API frozen, per-topic DocC articles (hosted at /docs on the docs
site), 90% line coverage, and Linux + every Apple platform in CI. Candidate post-1.0 features
include WebSocket / SSE endpoints, response-body streaming, a background-transfer hook, and a
swift-log bridge (as a separate product, keeping the core dependency-free). See ROADMAP.md in
the repo for the current state.
See SECURITY.md for supported versions, the package's security posture, and how to privately
report a vulnerability. A standing review lives in Documentation/SecurityAudit.md.
Husnain Ali (GitHub @ihusnainalii)
SwiftNetworkKit is source-available proprietary software (not open source). See FAQ Licensing and Support. Repo: https://github.com/ihusnainalii/SwiftNetworkKit · Docs: https://swiftnetworkkit.vercel.app/
Getting started
Guides
- Defining Endpoints
- Authentication and Token Refresh
- Security and Certificate Pinning
- Retry Policy
- Interceptors
- Request Management
- Caching
- Offline Request Queue
- Uploads Downloads and Progress
- Pagination and Batch
- Combine and SwiftUI
- Error Handling
- Observability
- Testing and Mocking
- Best Practices and a Complete Example
- Platform Notes, Thread Safety and Performance
Reference