Repository files navigation

Generate Swift client and server code from an OpenAPI document.

OpenAPI is a specification for documenting HTTP services. An OpenAPI document is written in either YAML or JSON, and can be read by tools to help automate workflows, such as generating the necessary code to send and receive HTTP requests.

Swift OpenAPI Generator is a Swift package plugin that can generate the ceremony code required to make API calls, or implement API servers.

The code is generated at build-time, so it's always in sync with the OpenAPI document and doesn't need to be committed to your source repository.

• Works with OpenAPI Specification versions 3.0 and 3.1.
• Streaming request and response bodies enabling use cases such as JSON event streams, and large payloads without buffering.
• Support for JSON, multipart, URL-encoded form, base64, plain text, and raw bytes, represented as value types with type-safe properties.
• Client, server, and middleware abstractions, decoupling the generated code from the HTTP client library and web framework.

To see these features in action, check out the list ofexample projects.

Swift OpenAPI Generator can be used to generate API clients and server stubs.

Below you can see some example code, or you can follow one of thestep-by-step tutorials.

The generatedClient type provides a method for each HTTP operation defined in the OpenAPI document¹ and can be used with any HTTP library that provides an implementation ofClientTransport.

import OpenAPIURLSessionimport Foundationletclient=Client(    serverURL:URL(string:"http://localhost:8080/api")!,    transport:URLSessionTransport())letresponse=tryawait client.getGreeting()print(try response.ok.body.json.message)

To implement a server, define a type that conforms to the generatedAPIProtocol, providing a method for each HTTP operation defined in the OpenAPI document¹.

The server can be used with any web framework that provides an implementation ofServerTransport, which allows you to register your API handlers with the HTTP server.

import OpenAPIRuntimeimport OpenAPIVaporimport VaporstructHandler:APIProtocol{func getGreeting(_ input:Operations.GetGreeting.Input)asyncthrows->Operations.GetGreeting.Output{letname= input.query.name??"Stranger"return.ok(.init(body:.json(.init(message:"Hello,\(name)!"))))}}@mainstructHelloWorldVaporServer{staticfunc main()asyncthrows{letapp=tryawaitApplication.make()lettransport=VaporTransport(routesBuilder: app)lethandler=Handler()try handler.registerHandlers(on: transport, serverURL:URL(string:"/api")!)tryawait app.execute()}}

The Swift OpenAPI Generator project is split across multiple repositories to enable extensibility and minimize dependencies in your project.

See alsoSupported OpenAPI features.

The generator is used during development and is supported on macOS, Linux, and Windows.

The generated code, runtime library, and transports are supported on moreplatforms, listed below.

To get started, check out thedocumentation, which containsstep-by-step tutorials.

You can also experiment withexample projects that useSwift OpenAPI Generator and integrate with other packages in the ecosystem.

Or if you prefer to watch a video, check outMeet Swift OpenAPIGenerator from WWDC23.