bootuz / swift-request

SwiftRequest

SwiftRequest is a lightweight, type-safe HTTP client for Swift, streamlining the construction and execution of HTTP requests.

Overview

SwiftRequest abstracts away the repetitive boilerplate code that's typically associated with setting up HTTP requests in Swift. It utilizes macros introduced in Swift 5.9, which can be associated with specific declarations to enhance and extend their functionality.

Here's a quick look at how you'd define a service to fetch quotes:

@Service(resource: "quotes")
class QuoteService {
    @GET<[Quote]>("random")
    private func getRandomQuotes(@QueryParam limit: Int? = nil) {}
    
    @GET<Quote>("{id}")
    private func getQuote(@PathParam by id: String) {}
}

To make a request using SwiftRequest, you can do the following:

let service = QuoteService(baseURL: "https://api.quotable.io")
let (quotes, _) = try await service.getRandomQuotes(limit: 5)
let (quote, _) = try await service.getQuote(by: "69Ldsxcdm-")

Supported HTTP Methods

SwiftRequest offers support for the following HTTP methods:

• @GET
• @POST
• @PUT
• @PATCH
• @DELETE
• @HEAD
• @OPTIONS

Each of these methods accepts a generic response type (could be Data), a string for the request path, and an optional dictionary to specify request headers.

@GET<Quote>("{id}", headers: ["Cache-Control": "max-age=640000"])

Parameters

SwiftRequest provides several parameters that can be used in conjunction with the HTTP methods:

• @Header: Use this property wrapper to define a request header. The header name is optional. If it's not provided, SwiftRequest uses the property name as the header name.

  func getQuote(@Header("Cache-Control") cacheControl: String) {}

• @QueryParam: Use this property wrapper to define a URL query parameter. The query parameter name is optional. If it's not provided, SwiftRequest uses the property name as the query parameter name.

  func getRandomQuotes(@QueryParam limit: Int? = nil) {}

  In this case, the limit parameter will be used as the query parameter name. Example: https://api.quotable.io/quotes/random?limit=10
• @PathParam: Use this property wrapper to define a path parameter in the URL. The path parameter name is optional. If it's not provided, SwiftRequest uses the property name as the path parameter name.

  @GET<Quote>("{id}")
  func getQuote(@PathParam by id: String) {}

  In this case, the id parameter will be used as the path parameter name. Example: https://api.quotable.io/quotes/123

  It's important to note that the path parameter name must match the name of the property that's being used to define the path parameter and need to be write in the path between curly braces.

• @Body: Use this property wrapper to define the request body. This wrapper can only be used with the @POST, @PUT, @PATCH, and @DELETE HTTP methods.

  @POST<Quote>("quotes")
  func createQuote(@Body quote: Quote) {}

  Here, the quote parameter will be used as the request body, and the Content-Type: application/json header will be automatically added to the request.
• @FieldParam: Use this property wrapper to define a field parameter in the request body. This wrapper can only be used with the @POST, @PUT, @PATCH, and @DELETE HTTP methods.

  @POST<Quote>("quotes")
  func createQuote(@FieldParam("author") authorName: String, @FieldParam content: String) {}

  In this case, the author and content parameters will be used as field parameters in the request body, and the Content-Type: application/x-www-form-urlencoded header will be automatically added to the request. Example: author=John%20Doe&content=Hello%20World

License

SwiftRequest is available under the MIT license. See the LICENSE for details.