[R] Add new R client generator #6351

wing328 · 2017-08-22T10:11:23Z

PR checklist

Read the contribution guidelines.
Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
Filed the PR against the correct branch: master for non-breaking changes and 3.0.0 branch for breaking (non-backward compatible) changes.

Description of the PR

Add R client generator based on R Petstore client provided by @ramnov

Still WIP

wing328 · 2017-08-23T16:19:54Z

samples/client/petstore/r_test/R/PetApi.r

+      if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) {
+        parsed <- jsonlite::fromJSON(httr::content(resp, "text", encoding = "UTF-8"),
+                                 simplifyVector = FALSE)
+        result <- Pet$fromJSON(parsed)


@ramnov is there any way we can provide a fromJSON method to construct the object based on a JSON string?

For other languages, there are libraries for (de)serialization between JSON and object. I wonder if R has similar package.

There is no package in R to deserialize/serialize between R6 object and JSON. fromJSON() and toJSON() methods have to be implemented by ourselves in R6 Classes. I believe Pet.R already has a toJSON() method. Can you add this fromJSON() method as well to Pet Class in Pet.R :

fromJSON = function(petJson) {
petObject <- jsonlite::fromJSON(petJson)
self$id <- petObject$id
self$category <- Element$new(petObject$category$id, petObject$category$name)
self$name <- petObject$name
self$photoUrls <- petObject$photoUrls
self$tags <- lapply(petObject$tags, function(x) Element$new(x$id, x$name))
self$status <- petObject$status
}

And then this function can be used in PetApi.R like this :

result <- Pet$new()$fromJSON(httr::content(resp, "text", encoding = "UTF-8"),
simplifyVector = FALSE)

wing328 · 2017-08-23T16:21:37Z

samples/client/petstore/r_test/R/PetApi.r

+      resp <- httr::GET(paste0(self$url),
+          httr::add_headers("User-Agent" = self$userAgent, "content-type" = "application/xml")
+          )
+      # TODO add support for query parameters "status"


@ramnov I'm not sure how query string can be added to httpr? Is there something like httr::add_queries? I couldn't find one in https://www.rdocumentation.org/packages/httr/versions/1.2.1

There is a query parameter in GET function.
Example : GET("http://httpbin.org/cookies/set", query = list(a = 1, b = 2))
will translate to http://httpbin.org/cookies/set?a=1&b=1
More Examples here : https://stackoverflow.com/questions/32742535/difference-between-query-and-body-in-httrpost

@ramnov OK. Will give that a try.

wing328 · 2017-08-23T16:24:00Z

samples/client/petstore/r_test/R/PetApi.r

+    basePath = NULL,
+    scheme = NULL,
+    url = NULL,
+    initialize = function(host, basePath, scheme){


@ramnov Can host, basePath, scheme be optional and we'll provide the default value based on the spec? For example, the default value for basePath is v2: https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/test/resources/2_0/petstore.yaml#L13

default values can be set during definition itself. To allow for optional arguments in initialize function, we just need to check whether the argument is "missing". Here is an example of setting default values and optional arguments in PetApi class :

PetApi <- R6::R6Class(
'PetApi',
public = list(
userAgent = "Swagger-Codegen/1.0.0/r",
host = "petstore.swagger.io",
basePath = "v2",
scheme = "http",
url = NULL,
initialize = function(host, basePath, scheme){
if (!missing(host)) {
stopifnot(is.character(host), length(host) == 1)
self$host <- host
}
if (!missing(basePath)) {
stopifnot(is.character(basePath), length(basePath) == 1)
self$basePath <- basePath
}
if (!missing(scheme)) {
stopifnot(is.character(scheme), length(scheme) == 1)
self$scheme <- scheme
}
self$url <- sprintf("%s://%s/%s/pet/", scheme, host, basePath)
}

Nice. Will incorporate these changes later today.

ramnov · 2017-08-27T21:54:47Z

modules/swagger-codegen/src/main/resources/r/api.mustache

-        parsed <- jsonlite::fromJSON(httr::content(resp, "text", encoding = "UTF-8"),
-                                 simplifyVector = FALSE)
-        result <- {{returnType}}$fromJSON(parsed)
+        result <- {{returnType}}$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)


{{returnType}}$new()$fromJSON

ramnov · 2017-08-27T21:56:37Z

modules/swagger-codegen/src/main/resources/r/model.mustache

+      {{/isPrimitiveType}}
+      {{^isPrimitiveType}}
+      {{#isListContainer}}
+      self${{name}} <- lapply({{classname}}Object${{name}}, function(x) {{datatype}}$new()$fromJSON(x)


Here, you are passing a data frame to fromJSON method. You should pass a JSON string like this :

self${{name}} <- lapply({{classname}}Object${{name}}, function(x) {{datatype}}$new()$fromJSON(jsonlite::toJSON(x))

ramnov · 2017-08-27T21:58:11Z

samples/client/petstore/r_test/R/Order.r

+      self$id <- OrderObject$id
+      self$pet_id <- OrderObject$pet_id
+      self$quantity <- OrderObject$quantity
+      self$ship_date <- Date$new()$fromJSON(OrderObject$ship_date)


Again you need to pass JSON to fromJSON rather than data frame :

Date$new()$fromJSON(jsonlite::toJSON(OrderObject$ship_date))

ramnov · 2017-08-27T21:58:54Z

samples/client/petstore/r_test/R/Pet.r

+    fromJSON = function(PetJson) {
+      PetObject <- jsonlite::fromJSON(PetJson)
+      self$id <- PetObject$id
+      self$category <- Category$new()$fromJSON(PetObject$category)


Category$new()$fromJSON(jsonlite::toJSON(PetObject$category))

ramnov · 2017-08-27T21:59:35Z

samples/client/petstore/r_test/R/Pet.r

+      self$category <- Category$new()$fromJSON(PetObject$category)
+      self$name <- PetObject$name
+      self$photo_urls <- PetObject$photo_urls
+      self$tags <- lapply(PetObject$tags, function(x) Tag$new()$fromJSON(x)


self$tags <- lapply(PetObject$tags, function(x) Tag$new()$fromJSON(jsonlite::toJSON(x))

ramnov · 2017-08-27T22:00:32Z

samples/client/petstore/r_test/R/PetApi.r

-        parsed <- jsonlite::fromJSON(httr::content(resp, "text", encoding = "UTF-8"),
-                                 simplifyVector = FALSE)
-        result <- Pet$fromJSON(parsed)
+        result <- Pet$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)


result <- Pet$new()$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)

ramnov · 2017-08-27T22:01:06Z

samples/client/petstore/r_test/R/PetApi.r

-        parsed <- jsonlite::fromJSON(httr::content(resp, "text", encoding = "UTF-8"),
-                                 simplifyVector = FALSE)
-        result <- Pet$fromJSON(parsed)
+        result <- Pet$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)


result <- Pet$new()$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)

ramnov · 2017-08-27T22:01:29Z

samples/client/petstore/r_test/R/PetApi.r

-        parsed <- jsonlite::fromJSON(httr::content(resp, "text", encoding = "UTF-8"),
-                                 simplifyVector = FALSE)
-        result <- Pet$fromJSON(parsed)
+        result <- Pet$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)


result <- Pet$new()$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)

ramnov · 2017-08-27T22:01:51Z

samples/client/petstore/r_test/R/PetApi.r

-        parsed <- jsonlite::fromJSON(httr::content(resp, "text", encoding = "UTF-8"),
-                                 simplifyVector = FALSE)
-        result <- ApiResponse$fromJSON(parsed)
+        result <- ApiResponse$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)


result <- ApiResponse$new()$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)

ramnov · 2017-08-27T22:02:18Z

samples/client/petstore/r_test/R/StoreApi.r

-        parsed <- jsonlite::fromJSON(httr::content(resp, "text", encoding = "UTF-8"),
-                                 simplifyVector = FALSE)
-        result <- Integer$fromJSON(parsed)
+        result <- Integer$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)


result <- Integer$new()$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)

ramnov · 2017-08-27T22:02:44Z

samples/client/petstore/r_test/R/StoreApi.r

-        parsed <- jsonlite::fromJSON(httr::content(resp, "text", encoding = "UTF-8"),
-                                 simplifyVector = FALSE)
-        result <- Order$fromJSON(parsed)
+        result <- Order$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)


result <- Order$new()$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)

ramnov · 2017-08-27T22:03:03Z

samples/client/petstore/r_test/R/StoreApi.r

-        parsed <- jsonlite::fromJSON(httr::content(resp, "text", encoding = "UTF-8"),
-                                 simplifyVector = FALSE)
-        result <- Order$fromJSON(parsed)
+        result <- Order$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)


result <- Order$new()$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)

ramnov · 2017-08-27T22:03:37Z

samples/client/petstore/r_test/R/UserApi.r

-        parsed <- jsonlite::fromJSON(httr::content(resp, "text", encoding = "UTF-8"),
-                                 simplifyVector = FALSE)
-        result <- User$fromJSON(parsed)
+        result <- User$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)


result <- User$new()$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)

ramnov · 2017-08-27T22:04:05Z

samples/client/petstore/r_test/R/UserApi.r

-        parsed <- jsonlite::fromJSON(httr::content(resp, "text", encoding = "UTF-8"),
-                                 simplifyVector = FALSE)
-        result <- Character$fromJSON(parsed)
+        result <- Character$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)


result <- Character$new()$fromJSON(httr::content(resp, "text", encoding = "UTF-8"), simplifyVector = FALSE)

ramnov · 2017-08-27T22:13:46Z

modules/swagger-codegen/src/main/resources/r/model.mustache

+      self${{name}} <- lapply({{classname}}Object${{name}}, function(x) {{datatype}}$new()$fromJSON(x)
+      {{/isListContainer}}
+      {{^isListContainer}}
+      self${{name}} <- {{datatype}}$new()$fromJSON({{classname}}Object${{name}})


self${{name}} <- {{datatype}}$new()$fromJSON(jsonlite::toJSON({{classname}}Object${{name}}))

I will also change line 88 from

self${{name}} <- lapply({{classname}}Object${{name}}, function(x) {{datatype}}$new()$fromJSON(x)

to

self${{name}} <- lapply({{classname}}Object${{name}}, function(x) {{datatype}}$new()$fromJSON(jsonlite::toJSON(x))

ramnov · 2017-08-31T01:42:49Z

modules/swagger-codegen/src/main/resources/r/api.mustache

+              "{{baseName}}" = {{paramName}}{{#hasMore}},{{/hasMore}}
+              {{/isFile}}
+              {{#isFile}}
+              "{{baseName}}" = upload_file({{paramName}}){{#hasMore}},{{/hasMore}}


httr::upload_file

ramnov · 2017-08-31T01:43:02Z

samples/client/petstore/r_test/R/PetApi.r

@@ -134,7 +134,7 @@ PetApi <- R6::R6Class(
          httr::add_headers("User-Agent" = self$userAgent, "accept" = "multipart/form-data", "content-type" = "application/json")
          ,body = list(
              "additionalMetadata" = additional_metadata,
-              "file" = file #TODO support file upload
+              "file" = upload_file(file)


httr::upload_file

Fixed via d76ab6d

…ger-codegen#6351

wing328 added 2 commits August 19, 2017 11:46

add r client codegen

4ecd361

update r api, model templates

8995d80

wing328 added Client: R Enhancement: New generator labels Aug 22, 2017

wing328 added this to the v2.3.0 milestone Aug 22, 2017

wing328 added 2 commits August 23, 2017 01:24

various fix

8fc8c8f

rename Json to JSON

978ef7f

wing328 commented Aug 23, 2017

View reviewed changes

more enhancements

842723e

ramnov reviewed Aug 27, 2017

View reviewed changes

wing328 added 2 commits August 28, 2017 10:20

fix json handling

141c233

add file upload support, var name to handle hyphen

c8cd980

ramnov reviewed Aug 31, 2017

View reviewed changes

wing328 added 2 commits August 31, 2017 09:46

use httr::upload_file

d76ab6d

Merge branch 'master' into r_generator

5c18ea7

wing328 merged commit a4c0975 into master Sep 3, 2017

wing328 mentioned this pull request Sep 3, 2017

Support for R code generation #2231

Closed

wing328 deleted the r_generator branch September 11, 2017 09:39

karussell added a commit to graphhopper/directions-api-clients that referenced this pull request Nov 14, 2017

added R client via master branch of swagger codecli, swagger-api/swag…

4afba0a

…ger-codegen#6351

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[R] Add new R client generator #6351

[R] Add new R client generator #6351

wing328 commented Aug 22, 2017 •

edited

Loading

wing328 Aug 23, 2017

ramnov Aug 27, 2017 •

edited

Loading

wing328 Aug 23, 2017

ramnov Aug 27, 2017

wing328 Aug 27, 2017

wing328 Aug 23, 2017 •

edited

Loading

ramnov Aug 27, 2017

wing328 Aug 27, 2017

ramnov Aug 27, 2017

ramnov Aug 27, 2017

ramnov Aug 27, 2017

ramnov Aug 27, 2017

ramnov Aug 27, 2017

ramnov Aug 27, 2017

ramnov Aug 27, 2017

ramnov Aug 27, 2017

ramnov Aug 27, 2017

ramnov Aug 27, 2017

ramnov Aug 27, 2017

ramnov Aug 27, 2017

ramnov Aug 27, 2017

ramnov Aug 27, 2017

ramnov Aug 27, 2017

wing328 Aug 28, 2017

ramnov Aug 31, 2017

ramnov Aug 31, 2017

wing328 Aug 31, 2017

[R] Add new R client generator #6351

[R] Add new R client generator #6351

Conversation

wing328 commented Aug 22, 2017 • edited Loading

PR checklist

Description of the PR

Choose a reason for hiding this comment

ramnov Aug 27, 2017 • 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

wing328 Aug 23, 2017 • 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

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

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

Choose a reason for hiding this comment

wing328 commented Aug 22, 2017 •

edited

Loading

ramnov Aug 27, 2017 •

edited

Loading

wing328 Aug 23, 2017 •

edited

Loading