Server Side Swift と swift-openapi-generator 実践ガイド: サーバとクライアントのコード生成のベストプラクティス

iPhone Dev Sapporo — April 5, 2025
https://devsap.connpass.com/event/347851/

Transcript

1. iPhone Dev Sapporo / 20250405 iPhone Dev Sapporo Server Side Swift ͱ swift- openapi-generator ࣮ફΨΠυ αʔόͱΫϥΠΞϯτͷίʔυ ੜ੒ͷϕετϓϥΫςΟε 2025-04-05
2. iPhone Dev Sapporo / 20250405 ࣗݾ঺հ ੁݪ ༞ – X : @yusuga_ – mixi2 : @yusuga – ߹ಉձࣾϐίε: ୅දࣾһ – גࣜձࣾΏΊΈ: iOS ςοΫϦʔυ –
3. iPhone Dev Sapporo / 20250405 ࠷ۙͷؔ৺ Server Side Swift – ڈ೥຤ʹ2ਓ݄ͷBFF αʔόΛ։ൃ –
4. iPhone Dev Sapporo / 20250405 ΫϥΠΞϯτ͔Β API ϦΫΤετΛ͢Δ࣮ ૷͸Ͳ͏͍ͯ͠·͔͢ʁʢ※SDK ͕ͳ͍৔ ߹ʣ खॻ͖ 1. openapi.yaml ͔ΒπʔϧΛ࢖༻͠ ͯίʔυΛੜ੒ 2.
5. iPhone Dev Sapporo / 20250405 openapi.yaml openapi: 3.1.0 info: title: HTTP Bingo API version: "1.0.0" servers: - url: https://httpbingo.org paths: /get: get: summary: GET method for /get endpoint responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetResponse' components: schemas: GetResponse: type: object properties: url: type: string example: "https://httpbingo.org/get" required: - url
6. iPhone Dev Sapporo / 20250405 SwaggerUI
7. iPhone Dev Sapporo / 20250405 openapi.yaml ͔Β Swift ίʔυΛੜ੒͢ Δπʔϧ OpenAPITools/openapi-generator – ࿝ฮͷ OSS – apple/swift-openapi-generator – ଴๬ͷ apple ੡ͷ generator –
8. iPhone Dev Sapporo / 20250405 swift-openapi-generator ͕ੜ੒͢Δίʔυ public struct Client: APIProtocol { /// Creates a new client. /// - Parameters: /// - serverURL: The server URL that the client connects to. Any server /// URLs defined in the OpenAPI document are available as static methods /// on the ``Servers`` type. /// - configuration: A set of configuration values for the client. /// - transport: A transport that performs HTTP operations. /// - middlewares: A list of middlewares to call before the transport. public init( serverURL: Foundation.URL, configuration: Configuration = .init(), transport: any ClientTransport, middlewares: [any ClientMiddleware] = [] ) { self.client = .init( serverURL: serverURL, configuration: configuration, transport: transport, middlewares: middlewares ) } }
9. iPhone Dev Sapporo / 20250405 swift-openapi-generator ͕ੜ੒͢Δίʔυ /// GET method for /get endpoint /// /// - Remark: HTTP `GET /get`. /// - Remark: Generated from `#/paths//get/get`. public func getGet(_ input: Operations.GetGet.Input) async throws -> Operations.GetGet.Output { try await client.send( input: input, forOperation: Operations.GetGet.id, serializer: { input in let path = try converter.renderedPath( template: "/get", parameters: [] ) var request: HTTPTypes.HTTPRequest = .init( soar_path: path, method: .get ) suppressMutabilityWarning(&request) converter.setAcceptHeader( in: &request.headerFields, contentTypes: input.headers.accept ) return (request, nil) },
10. iPhone Dev Sapporo / 20250405 swift-openapi-generator ͕ੜ੒͢Δίʔυ deserializer: { response, responseBody in switch response.status.code { case 200: let contentType = converter.extractContentTypeIfPresent(in: response.headerFields) let body: Operations.GetGet.Output.Ok.Body let chosenContentType = try converter.bestContentType( received: contentType, options: [ "application/json" ] ) switch chosenContentType { case "application/json": body = try await converter.getResponseBodyAsJSON( Components.Schemas.GetResponse.self, from: responseBody, transforming: { value in .json(value) } ) default: preconditionFailure("bestContentType chose an invalid content type.") } return .ok(.init(body: body)) } } ) }
11. iPhone Dev Sapporo / 20250405 API ϦΫΤετ let result = try await httpBingoClient.getGet()
12. iPhone Dev Sapporo / 20250405 Կ͕خ͍͠ͷ͔ openapi.yaml == API ͷ࢓༷ ʹͰ͖Δ – API ࢓༷ॻ΋ openapi.yaml ͔Βੜ੒΋Ͱ͖Δ – πʔϧͰίʔυੜ੒͢Ε͹ API ͷ࢓༷Λຬͨͨ͠ Swift ίʔυʹͳ͍ͬͯΔ – ܕɺύεɺύϥϝʔλ໊ͳͲͷࢦఆɺೖྗϛε ͕ػցతʹͳͤ͘Δ – API ͷ࢓༷͕มΘͬͨΒ openapi.yaml Λߋ৽͠ɺ ࠶౓ίʔυΛੜ੒͢Δ –
13. iPhone Dev Sapporo / 20250405 ͍͔ͭ͘೰ΈϙΠϯτ openapi.yaml ͸Ͳ͜ʹஔ͘΂͖͔ – ίʔυੜ੒͸ͲͷλΠϛϯάͰ͢΂͖͔ – ੜ੒ͨ͠ίʔυ͸ commit ͢΂͖͔ –
14. iPhone Dev Sapporo / 20250405 Q. openapi.yaml ͸Ͳ͜ʹஔ ͘΂͖͔ A. ϦϙδτϦΛ෼͚Δ
15. iPhone Dev Sapporo / 20250405 Q. ίʔυੜ੒͸ͲͷλΠϛϯ άͰ͢΂͖͔ A. ϏϧυϓϥάΠϯͰಈతʹ ੜ੒͢Δ
16. iPhone Dev Sapporo / 20250405 Q. ੜ੒ͨ͠ίʔυ͸ commit ͢΂͖͔ A. ϏϧυϓϥάΠϯͰಈతʹ ੜ੒͢ΔͷͰɺcommit ͢Δ ඞཁ͕ͳ͍
17. iPhone Dev Sapporo / 20250405 σϞͷߏ੒ ϦϙδτϦ ಺༰ openapi- sample-spec openapi.yaml ஔ͖৔ & Ϗϧυ ϓϥάΠϯΛಈ࡞ͤ͞Δ openapi- sample- client ΞϓϦʢAPIϦΫΤετΛ͢Δ ଆʣ openapi- sample- server αʔόʢAPIϦΫΤετΛड͚ Δଆʣ ※ ΞϓϦͱαʔόଆͰ Build Plugin Λॻ͔ͳ͍
18. iPhone Dev Sapporo / 20250405 Tips spec ଆͰϏϧυϓϥάΠϯΛಈ͔͢͜ͱͰɺར༻͢Δଆ͸Ϗϧυ ϓϥάΠϯ͕ෆཁͳߏ੒ʹͰ͖ͯ Package.swift ͷهड़ΛݮΒͤΔ – ґଘϥΠϒϥϦଆͰϏϧυϓϥάΠϯΛಈ͔͢ʹ͸1ͭҎ্ͷఆٛ ͕ඞཁ – σϞͰ͸ private struct Dummy() Λ௥Ճ – openapi-generator-config.yaml Ͱίʔυੜ੒ํ๏ΛΧελ ϚΠζ – filter: operations, tags, paths, schemas – spec ଆͷ Package.swift ͰϥΠϒϥϦ୯ҐͰ openapi.yaml Λ෼ ͚Δ͜ͱ͸Մೳ –
19. iPhone Dev Sapporo / 20250405 ࠓޙͷظ଴ ڞ௨͢Δ schemas ΍ parameters ͷ Έɺผͷ openapi.yaml ʹఆ͍͕ٛͨ͠ swift-openapi-generator ͸ɺ· ͩผϑΝΠϧ΁ͷ $ref Λαϙʔτͯ͠ ͍ͳ͍ –
20. iPhone Dev Sapporo / 20250405 ͝੩ௌ ͋Γ͕ͱ͏͍͟͝·ͨ͠ʂ