Swift5 Vapor 4 client library #9625

aymanbagabas · 2021-05-30T20:55:45Z

This PR includes all commits from #9624 and #9608

PR checklist

Read the contribution guidelines.
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
Run the following to build the project and update samples:
```
./mvnw clean package 
./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh
```
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
For Windows users, please run the script in Git BASH.
File the PR against the correct branch: master, 5.1.x, 6.0.x
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

4brunu · 2021-05-31T10:19:57Z

Before review this PR, let's wait for #9624 to get merged.

4brunu · 2021-06-01T21:24:44Z

Hey, I opened a PR with some spacing and CI improvements here aymanbagabas#17.

4brunu

@aymanbagabas could you please take a look at those two build errors? Thanks

samples/client/petstore/swift5/vaporLibrary/Sources/PetstoreClient/Extensions.swift

* [swift5] try to remove changes in model and api * [swift5] update sample projects * [swift5] update sample projects * [swift5] update sample projects * [swift5] update sample projects * [swift5] update sample projects * [swift5] update sample projects * [swift5] update sample projects * [swift5] update sample projects * [swift5] update sample projects * [swift5] update sample projects * [swift5] update sample projects

4brunu · 2021-06-02T09:13:48Z

@aymanbagabas thanks for all the work until now, and for extracting a lot of PRs from the original one on vapor.
I don't see nothing wrong in this PR.
The api file with vapor is a lot different from the others, but I think that is fine, since it's a totally different implementation.

One question that I would like to have your opinion on is, you choose an enum to represent the http status code, and I was thinking in suggesting to use a just one response object with an int for http status code.
But I also understand that with an enum to represent the http status code, you have a finite possibilities on the response.
So, unless you think that having only one response object with an int for http status code it's better than the enum, I think this PR is ready to merge 👍

EDIT: After reviewing it once more, I left some questions for you.

4brunu

I left some questions that I would like to discuss with you

4brunu · 2021-06-02T09:31:17Z

samples/client/petstore/swift5/vaporLibrary/Sources/PetstoreClient/APIs/StoreAPI.swift

+    public enum PlaceOrder {
+        case http200(value: Order, raw: ClientResponse)
+        case http400(value: Void, raw: ClientResponse)
+        case http0(value: Order, raw: ClientResponse)


@aymanbagabas I think at least the default case, should have an int with the status code, because it can be something that may be important for debug proposes like 401 or 403 for example.
And Maybe instead of http0 it could be httpUnknown to be more clearer?

ClientResponse type has a .status property that has the response code. I agree, httpUnknown is more clearer. Also, I think that case should optionally decode the response since we don't really know what the response would look like.

You are right, I haven't noticed that ClientResponse has http status code, headers, etc, that's nice 👍

yeah, Vapor is a really cool framework, it forces you to write beautiful code. You should try it sometime. There's vapor-server-codegen, I think bringing that to the OpenAPI generator would be a great idea.

When you have time, please try to change http0 to httpUnknown and check the value Type in each enum case, to see what makes more sense, for us to merge this 🙂

After running some tests, http0 is named that way because the generator returns status code 0 when it's the default case. Thus, renaming it to httpUnknown is not possible. What I would do is, when there is no default case, .http0 would only contain a ClientResponse instance. Otherwise, the default case defines what type should be expected in the return.

samples/client/petstore/swift5/vaporLibrary/Sources/PetstoreClient/APIs/StoreAPI.swift

4brunu · 2021-06-02T16:37:06Z

modules/openapi-generator/src/main/resources/swift5/api.mustache

@@ -275,7 +275,7 @@ extension {{projectName}} {
        case http{{code}}(value: {{#dataType}}{{{dataType}}}{{/dataType}}{{^dataType}}Void{{/dataType}}, raw: ClientResponse)


@aymanbagabas I think only the status code should have 200 should have something like this
If it's 400 we don't know the response type.

case http200(value: Double, raw: ClientResponse) case http400(value: ????, raw: ClientResponse)

Per the specs, you can absolutely define responses for any status code. Maybe I should remove the value and only return ClientResponse when the response is empty instead of returning Void for the value. What do you think?

If you are able to set te right responses for each status code, I think that would be great.
But it that is too much work, returning only the ClientResponse would also do it.

That's how it is right now, when the response in the specs is empty, it returns Void for the value. As long as the specs contain a response schema, it would have that in the value. I will change it to ClientResponse only when the response is empty aka no dataType for the response.

I think now it put's the success response in all status code's, or am I wrong?

No, the Petstore specs are different, for examples 2_0/petstore.yaml doesn't have a 200 response schema on POST /pet while the 3_0 version does. Thus, the generated code for 2_0 doesn't have a 200 response enum case for POST /pet aka addPet operation.

4brunu · 2021-06-02T17:19:07Z

CI is failing because there are some stuff that are outdated.
Can you please run the following commands and commit the changes?

./mvnw clean package 
./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh

Thanks

aymanbagabas · 2021-06-02T18:18:53Z

looks like something is causing the csharp generator to fail

4brunu · 2021-06-03T15:30:58Z

CI failure is not related to this PR.

4brunu · 2021-06-07T08:25:49Z

@aymanbagabas Thanks for your effort in contributing with the vapor integration, and also in splitting the initial big PR into smaller ones that made multiple improvements to the Swift generator 👍

aymanbagabas force-pushed the swift5-vapor branch 2 times, most recently from 749d850 to c66c103 Compare May 30, 2021 21:03

aymanbagabas force-pushed the swift5-vapor branch 2 times, most recently from a4cfd4a to 0acee34 Compare June 1, 2021 16:55

4brunu requested changes Jun 1, 2021

View reviewed changes

samples/client/petstore/swift5/vaporLibrary/Sources/PetstoreClient/Extensions.swift Outdated Show resolved Hide resolved

samples/client/petstore/swift5/vaporLibrary/Sources/PetstoreClient/Extensions.swift Outdated Show resolved Hide resolved

aymanbagabas and others added 3 commits June 1, 2021 17:34

[swift5] Add Vapor client library

13b8f01

Update samples

bda7f3b

aymanbagabas force-pushed the swift5-vapor branch from 7c639c4 to bda7f3b Compare June 1, 2021 21:41

4brunu reviewed Jun 2, 2021

View reviewed changes

[swift5] vapor: return clientResponse when no default case

265e469

aymanbagabas force-pushed the swift5-vapor branch from 393172d to 37dbfdb Compare June 2, 2021 17:08

Update samples

1d62252

aymanbagabas force-pushed the swift5-vapor branch from 37dbfdb to 1d62252 Compare June 2, 2021 17:23

This was referenced Jun 4, 2021

[swift][client] make swift 5 generator stable #9666

Merged

[REQ] [Swift5] POP proposal #8653

Open

wing328 added Client: Swift Enhancement: Feature labels Jun 6, 2021

wing328 added this to the 5.2.0 milestone Jun 6, 2021

wing328 merged commit f923a0e into OpenAPITools:master Jun 6, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Swift5 Vapor 4 client library #9625

Swift5 Vapor 4 client library #9625

aymanbagabas commented May 30, 2021

4brunu commented May 31, 2021

4brunu commented Jun 1, 2021

4brunu left a comment

4brunu commented Jun 2, 2021 •

edited

Loading

4brunu left a comment

4brunu Jun 2, 2021

aymanbagabas Jun 2, 2021

4brunu Jun 2, 2021

aymanbagabas Jun 2, 2021

4brunu Jun 2, 2021

aymanbagabas Jun 2, 2021

4brunu Jun 2, 2021

aymanbagabas Jun 2, 2021 •

edited

Loading

4brunu Jun 2, 2021

aymanbagabas Jun 2, 2021

4brunu Jun 2, 2021

aymanbagabas Jun 2, 2021

4brunu commented Jun 2, 2021

aymanbagabas commented Jun 2, 2021

4brunu commented Jun 3, 2021

4brunu commented Jun 7, 2021

		@@ -275,7 +275,7 @@ extension {{projectName}} {
		case http{{code}}(value: {{#dataType}}{{{dataType}}}{{/dataType}}{{^dataType}}Void{{/dataType}}, raw: ClientResponse)

Swift5 Vapor 4 client library #9625

Swift5 Vapor 4 client library #9625

Conversation

aymanbagabas commented May 30, 2021

PR checklist

4brunu commented May 31, 2021

4brunu commented Jun 1, 2021

4brunu left a comment

Choose a reason for hiding this comment

4brunu commented Jun 2, 2021 • edited Loading

4brunu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aymanbagabas Jun 2, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

4brunu commented Jun 2, 2021

aymanbagabas commented Jun 2, 2021

4brunu commented Jun 3, 2021

4brunu commented Jun 7, 2021

4brunu commented Jun 2, 2021 •

edited

Loading

aymanbagabas Jun 2, 2021 •

edited

Loading