Missing instructions in client examples to start the local server

[brentvegafederal]

Question

I'm trying to start an example server or get through some of the examples, but everything end up throwing an error. Any ideas?

swift run --package-path hello-world-urlsession-client-example

...

[138/138] Applying HelloWorldURLSessionClient
Build of product 'HelloWorldURLSessionClient' complete! (21.04s)
Swift/ErrorType.swift:253: Fatal error: Error raised at top level: Client error - cause description: 'Transport threw an error.', underlying error: Could not connect to the server., operationID: getGreeting, operationInput: Input(query: HelloWorldURLSessionClient.Operations.getGreeting.Input.Query(name: nil), headers: HelloWorldURLSessionClient.Operations.getGreeting.Input.Headers(accept: [OpenAPIRuntime.AcceptHeaderContentType<HelloWorldURLSessionClient.Operations.getGreeting.AcceptableContentType>(contentType: HelloWorldURLSessionClient.Operations.getGreeting.AcceptableContentType.json, quality: OpenAPIRuntime.QualityValue(thousands: 1000))])), request: GET /greet [accept: application/json], requestBody: <nil>, baseURL: http://localhost:8080/api, response: <nil>, responseBody: <nil>

swift run --package-path hello-world-async-http-client-example


[1033/1033] Applying HelloWorldAsyncHTTPClient
Build of product 'HelloWorldAsyncHTTPClient' complete! (37.16s)
Swift/ErrorType.swift:253: Fatal error: Error raised at top level: Client error - cause description: 'Transport threw an error.', underlying error: The operation couldn’t be completed. (AsyncHTTPClient.HTTPClient.NWPOSIXError error 1.), operationID: getGreeting, operationInput: Input(query: HelloWorldAsyncHTTPClient.Operations.getGreeting.Input.Query(name: nil), headers: HelloWorldAsyncHTTPClient.Operations.getGreeting.Input.Headers(accept: [OpenAPIRuntime.AcceptHeaderContentType<HelloWorldAsyncHTTPClient.Operations.getGreeting.AcceptableContentType>(contentType: HelloWorldAsyncHTTPClient.Operations.getGreeting.AcceptableContentType.json, quality: OpenAPIRuntime.QualityValue(thousands: 1000))])), request: GET /greet [accept: application/json], requestBody: <nil>, baseURL: http://localhost:8080/api, response: <nil>, responseBody: <nil>
[1]    68970 trace trap  swift run --package-path hello-world-async-http-client-example

[czechboy0]

Thanks @brentvegafederal for reporting this - we somehow forgot to document that you need to spin up e.g. https://github.com/apple/swift-openapi-generator/tree/main/Examples/hello-world-vapor-server-example in a separate tab first.

Would you mind updating that README.md in both the URLSession and AHC example?

[brentvegafederal]

I am happy to update the docs, but I'm not quite sure how you want them updated because spinning up Vapor to run the URLSession or AHC example doesn't make sense.

[czechboy0]

It's a pre-requisite of running the client example. We need a server to connect to, and the Vapor and Hummingbird examples are compatible servers you can connect to. We should just mention it there, to avoid confusion of why the client examples don't work out of the box.

[brentvegafederal]

Ok, got it, I'll add something about it.

[brentvegafederal]

2 pull requests created (I hope) correctly...

#703
#704

[simonjbeaumont]

Each of the client examples does include this already:

The server can be started by running any of the Hello World server examples locally.

Is that enough without having to duplicate the information from each of the server examples?

[czechboy0]

Whoops that's my fault, I also missed that line in the README and recommended we add it, sorry.