Skip to content

Latest commit

 

History

History
75 lines (57 loc) · 2.9 KB

README.md

File metadata and controls

75 lines (57 loc) · 2.9 KB

SwiftHTTPStatusCodes

Build Status Carthage compatible Pod Version Pod Platform Pod License

Swift enum wrapper for easier handling of HTTP status codes.

The purpose of this library is to improve to clarify of code and remove the need for checking of status codes as numbers (==200), or as a range of values (== 2xx) - instead replacing it with descriptive enums.

All the RF2616 standard status codes are supported with a few added ones from the Wikipedia page.

As of version 3.0.0 of this framework, the list of status codes are directly generated from a online IANA CSV. The HTML page has a last updated field, and this is also mirrored in the header comments to identify which version this framework is currently using.
If this library is out of date compared to this page please open an issue and I will update the list.

Usage

Swift versions support

  • Swift 5.1 - use version 3.3.2
  • Swift 5 - use version 3.3.1
  • Swift 4 - use version 3.3.0
  • Swift 3 - use version 3.1
  • Older versions - use version 3.0

Swift Package Manager

Add this package to the dependencies in your Package.swift file:

.package(url: "https://github.com/rhodgkins/SwiftHTTPStatusCodes.git", .upToNextMajor(from: "3.0.0"))

Carthage

Cartfile:

github "rhodgkins/SwiftHTTPStatusCodes" ~> 3.3

Source code:

import HTTPStatusCodes

CocoaPods

Podfile:

pod 'HTTPStatusCodes', '~> 3.3.0'

Source code:

import HTTPStatusCodes

Manually

Or drop in the Swift files inside the Sources folder into your project.

Helper methods

There are Bool properties on the enum for checking if a status code is of a certain category:

isInformational
isSuccess
isRedirection
isClientError
isServerError

There is also an extension on HTTPURLResponse to obtain a status code enum directly and to init with one:

var statusCodeValue: HTTPStatusCode?
init?(url: URL, statusCode: HTTPStatusCode, httpVersion: String?, headerFields: [String : String]?)