base on Generate Swift client and server code from an OpenAPI document. # Swift OpenAPI Generator [](https://www.swift.org/sswg/) [](https://swiftpackageindex.com/apple/swift-openapi-generator/documentation) [](https://github.com/apple/swift-openapi-generator/releases) [](https://swiftpackageindex.com/apple/swift-openapi-generator) Generate Swift client and server code from an OpenAPI document. ## Overview [OpenAPI][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. ## Features - 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 of [example projects][examples-generator]. ## Usage 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 the [step-by-step tutorials][tutorials-generator]. ### Using a generated API client The generated `Client` type provides a method for each HTTP operation defined in the OpenAPI document[^example-openapi-yaml] and can be used with any HTTP library that provides an implementation of `ClientTransport`. ```swift import OpenAPIURLSession import Foundation let client = Client( serverURL: URL(string: "http://localhost:8080/api")!, transport: URLSessionTransport() ) let response = try await client.getGreeting() print(try response.ok.body.json.message) ``` ### Using generated API server stubs To implement a server, define a type that conforms to the generated `APIProtocol`, providing a method for each HTTP operation defined in the OpenAPI document[^example-openapi-yaml]. The server can be used with any web framework that provides an implementation of `ServerTransport`, which allows you to register your API handlers with the HTTP server. ```swift import OpenAPIRuntime import OpenAPIVapor import Vapor struct Handler: APIProtocol { func getGreeting(_ input: Operations.GetGreeting.Input) async throws -> Operations.GetGreeting.Output { let name = input.query.name ?? "Stranger" return .ok(.init(body: .json(.init(message: "Hello, \(name)!")))) } } @main struct HelloWorldVaporServer { static func main() async throws { let app = Vapor.Application() let transport = VaporTransport(routesBuilder: app) let handler = Handler() try handler.registerHandlers(on: transport, serverURL: URL(string: "/api")!) try await app.execute() } } ``` ## Package ecosystem The Swift OpenAPI Generator project is split across multiple repositories to enable extensibility and minimize dependencies in your project. | Repository | Description | | ---------- | ----------- | | [apple/swift-openapi-generator][repo-generator] | Swift package plugin and CLI | | [apple/swift-openapi-runtime][repo-runtime] | Runtime library used by the generated code | | [apple/swift-openapi-urlsession][repo-urlsession] | `ClientTransport` using [URLSession][urlsession] | | [swift-server/swift-openapi-async-http-client][repo-ahc] | `ClientTransport` using [AsyncHTTPClient][ahc] | | [swift-server/swift-openapi-vapor][repo-vapor] | `ServerTransport` using [Vapor][vapor] | | [swift-server/swift-openapi-hummingbird][repo-hummingbird] | `ServerTransport` using [Hummingbird][hummingbird] | | [swift-server/swift-openapi-lambda][repo-lambda] | `ServerTransport` using [AWS Lambda][lambda] | ## Requirements and supported features | Generator versions | Supported OpenAPI versions | Minimum Swift version | | ------------------ | -------------------------- | --------------------- | | `1.0.0` ... `main` | 3.0, 3.1 | 5.9 | See also [Supported OpenAPI features][supported-openapi-features]. ### Supported platforms and minimum versions The generator is used during development and is supported on macOS and Linux. The generated code, runtime library, and transports are supported on more platforms, listed below. | Component | macOS | Linux | iOS | tvOS | watchOS | visionOS | | ----------------------------------: | :--- | :--- | :- | :-- | :----- | :------ | | Generator plugin and CLI | ✅ 10.15+ | ✅ | ✖️ | ✖️ | ✖️ | ✖️ | | Generated code and runtime library | ✅ 10.15+ | ✅ | ✅ 13+ | ✅ 13+ | ✅ 6+ | ✅ 1+ | > [!NOTE] > When using Visual Studio Code or other editors that rely on [SourceKit-LSP](https://github.com/swiftlang/sourcekit-lsp), the editor may not correctly recognize generated code within the same module. As a workaround, consider creating a separate target for code generation and then importing it into your main module. For more details, see the discussion in [swiftlang/sourcekit-lsp#665](https://github.com/swiftlang/sourcekit-lsp/issues/665#issuecomment-2093169169). ## Documentation and example projects To get started, check out the [documentation][docs-generator], which contains [step-by-step tutorials][tutorials-generator]. You can also experiment with [example projects][examples-generator] that use Swift OpenAPI Generator and integrate with other packages in the ecosystem. Or if you prefer to watch a video, check out [Meet Swift OpenAPI Generator](https://developer.apple.com/wwdc23/10171) from WWDC23. [openapi]: https://openapis.org [repo-generator]: https://github.com/apple/swift-openapi-generator [docs-generator]: https://swiftpackageindex.com/apple/swift-openapi-generator/documentation [tutorials-generator]: https://swiftpackageindex.com/apple/swift-openapi-generator/tutorials/swift-openapi-generator [supported-openapi-features]: https://swiftpackageindex.com/apple/swift-openapi-generator/documentation/swift-openapi-generator/supported-openapi-features [examples-generator]: https://github.com/apple/swift-openapi-generator/blob/main/Examples/README.md [repo-runtime]: https://github.com/apple/swift-openapi-runtime [repo-urlsession]: https://github.com/apple/swift-openapi-urlsession [urlsession]: https://developer.apple.com/documentation/foundation/urlsession [repo-ahc]: https://github.com/swift-server/swift-openapi-async-http-client [ahc]: https://github.com/swift-server/async-http-client [repo-vapor]: https://github.com/swift-server/swift-openapi-vapor [vapor]: https://github.com/vapor/vapor [repo-hummingbird]: https://github.com/swift-server/swift-openapi-hummingbird [hummingbird]: https://github.com/hummingbird-project/hummingbird [repo-lambda]: https://github.com/swift-server/swift-openapi-lambda [lambda]: https://docs.aws.amazon.com/lambda/latest/dg/welcome.html [^example-openapi-yaml]: <details><summary>Example OpenAPI document (click to expand)</summary> ```yaml openapi: '3.1.0' info: title: GreetingService version: 1.0.0 servers: - url: https://example.com/api description: Example service deployment. paths: /greet: get: operationId: getGreeting parameters: - name: name required: false in: query description: The name used in the returned greeting. schema: type: string responses: '200': description: A success response with a greeting. content: application/json: schema: $ref: '#/components/schemas/Greeting' components: schemas: Greeting: type: object description: A value with the greeting contents. properties: message: type: string description: The string representation of the greeting. required: - message ``` </details> ", Assign "at most 3 tags" to the expected json: {"id":"10789","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"