Add @Field, @Part and @Path #1448

WonderCsabo · 2015-06-05T17:37:49Z

@PathParam: allows to add different url variable name than the method parameter name. It can be expanded later to use url encoding.

@Post("/login{id}")
void login(User user, @Path("id") String identifier);

@Field: allows to add post parameters as method parameters, just like url variables. Form data and multipart data are supported.

@Post("/login")
void login(@Field String username, @Field String password);

About multipart: currently, it requires some boilerplate, but much less than before:

@Post("/profilepicture")
@RequiresHeader("Content-Type")
void upload(@Field String name, @Field FileResource picture);

userRestClient.setHeader("Content-Type", MULTIPART_FORM_DATA);
// normal calls

It would be better to remove the need for this.

we could use 323 custom rest headers #967, to add @Headers(@Header(headerName = "Content-Type", value = MULTIPART_FORM_DATA ))
create a @Part annotation which automatically adds the header, and works like @Field
multi-part post flag for @Post which adds the header
add the header if the parameter type is Resource
combination of them

I am open to any suggestions.

Implements #1438.

WonderCsabo · 2015-06-17T08:53:42Z

@yDelouis @dodgex any feedback about multipart?

yDelouis · 2015-06-17T19:52:14Z

I would add the annotations @Headers and @Header for that.
I would have named the new annotation @Post.Param @FormParam.

WonderCsabo · 2015-06-17T19:55:14Z

@yDelouis adding that header again and again is a little bit dumb i think. Maybe we should create @MultiPart which behaves exactly like @Post.Param, just adds the header automatically. Like retrofit.

yDelouis · 2015-06-17T20:17:05Z

With retrofit, according to the main page, you have to add @MultiPart and @Part for each param.
What about copying what they did :

add @PathParam for replacing a placeholder in the url (or keep it as it is, without any annotation).
add @Field for form post request.
add @Part for multipart parts.
add @UrlParam for url params.

@Fieldand @Part are incompatible.
And the headers would be added automatically.

Maybe we should wait the plugin system also.

WonderCsabo · 2015-06-17T20:18:28Z

What is the difference between @PathParam and @UrlParam?

yDelouis · 2015-06-17T21:02:07Z

@PathParam replaces a placeholder, like we do now without annotation.
@UrlParam add will add ?name=value or &name=value to the url.

WonderCsabo · 2015-06-17T21:09:20Z

Are you sure @UrlParam is needed? It is still achievable with @PathParam. For complex queries, we should implement @QueryMap (#900). Actually @UrlParam is also nice, but @QueryMap is more important i think.

I rename @Post.Param to @Field and implement @Part.

yDelouis · 2015-06-18T07:47:39Z

@UrlParam is not necessary but would be convenient.
@QueryMap would be nice too.

WonderCsabo · 2015-06-18T08:02:13Z

These two would only work with @Get, am i right?

yDelouis · 2015-06-18T08:26:44Z

No, this could be used with @Post also. In my company, the webservices are not really REST services and we have to post data with url params.

WonderCsabo · 2015-06-18T08:27:50Z

Well, in that case we could allow it for any HTTP method.

WonderCsabo · 2015-06-18T17:31:52Z

I realized that we already use the "url variable" term for path parameters in the existing code and messages. Maybe we should use @QueryParam instead of @UrlParam?

WonderCsabo · 2015-06-23T20:33:15Z

This PR is already big. The work for @Path, @Field and @Part is complete. I will add @Query and @QueryMap if you merge this, @yDelouis.

yDelouis · 2015-06-23T21:38:22Z

Okay for making another PR.

WonderCsabo · 2015-07-15T17:14:18Z

@yDelouis i am starting to think we should require annotations for all method parameters in a REST method. That way the AA code would be more simpler, and also it would be much more clearer for the caller how to use the parameters. It will break the API, but users will see the change and the necessary actions at compile-time.

yDelouis · 2015-07-16T07:23:42Z

You're right. And with the plugin system, we are breaking everything so we shouldn't worry about that.

WonderCsabo · 2015-07-16T07:47:35Z

👍

yDelouis · 2015-09-20T12:28:49Z

...spring/rest-spring/src/main/java/org/androidannotations/rest/spring/handler/PathHandler.java

Why did you put process before validate ? It's a bit strange to me.

You are right, i do not know why i did it.

yDelouis · 2015-09-20T13:00:30Z

It seems good. Could you rebase and address my comments.
When done, you can merge it by yourself to be sure you won't have to rebase twice.
We will have to edit the wiki then.

Add @field, @part and @path

WonderCsabo · 2015-09-21T10:51:44Z

Wiki edited.

WonderCsabo force-pushed the 1438_restFormParamAnnotation branch 3 times, most recently from 3be3e1a to 3ed9709 Compare June 10, 2015 16:46

WonderCsabo force-pushed the 1438_restFormParamAnnotation branch from 3ed9709 to 624acaf Compare June 16, 2015 19:03

WonderCsabo mentioned this pull request Jun 16, 2015

Add static headers from annotation #1470

Merged

WonderCsabo force-pushed the 1438_restFormParamAnnotation branch from 624acaf to 70cee67 Compare June 17, 2015 21:48

WonderCsabo changed the title ~~Add @Post.Param and @PathParam~~ Add @Field and @PathParam Jun 17, 2015

WonderCsabo force-pushed the 1438_restFormParamAnnotation branch from 35201be to bad67c5 Compare June 23, 2015 20:32

WonderCsabo force-pushed the 1438_restFormParamAnnotation branch 2 times, most recently from 37aebd9 to bd903b1 Compare June 23, 2015 23:41

WonderCsabo changed the title ~~Add @Field and @PathParam~~ Add @Field, @Part and @Path Jun 24, 2015

WonderCsabo force-pushed the develop branch from 320126a to edf729e Compare June 24, 2015 22:49

WonderCsabo force-pushed the 1438_restFormParamAnnotation branch from bd903b1 to 8e2d87c Compare September 11, 2015 18:36

yDelouis reviewed Sep 20, 2015
View reviewed changes

WonderCsabo added 14 commits September 21, 2015 11:17

Add @field annotation

607e02a

Create PostHandler.FieldHandler

cc8cea5

Add @path

4dc1f18

Refactor ValidatorHelper.hasSomeAnnotation methods

345f325

Use @path for figuring out the url variable

c943afc

Compile-time tests for @path

79c8ef1

Add functional test for @path

5592ae5

Inject post parameters into the request entity

c8bf18e

Add functional test for @field

5113cb8

Compile time test for @field

eb3459f

Add @part annotation

6ae48f8

Process @part annotation

d66c9d4

Add functional tests for @part

39d143a

Add compile-time test for @part

c2fe71e

WonderCsabo force-pushed the 1438_restFormParamAnnotation branch from 8e2d87c to c2fe71e Compare September 21, 2015 10:04

WonderCsabo added a commit that referenced this pull request Sep 21, 2015

Merge pull request #1448 from WonderCsabo/1438_restFormParamAnnotation

774f80f

Add @field, @part and @path

WonderCsabo merged commit 774f80f into androidannotations:develop Sep 21, 2015

WonderCsabo deleted the 1438_restFormParamAnnotation branch September 21, 2015 10:15

WonderCsabo added this to the 4.0 milestone Sep 21, 2015

Add @Field, @Part and @Path #1448

Add @Field, @Part and @Path #1448

Uh oh!

Conversation

WonderCsabo commented Jun 5, 2015

Uh oh!

WonderCsabo commented Jun 17, 2015

Uh oh!

yDelouis commented Jun 17, 2015

Uh oh!

WonderCsabo commented Jun 17, 2015

Uh oh!

yDelouis commented Jun 17, 2015

Uh oh!

WonderCsabo commented Jun 17, 2015

Uh oh!

yDelouis commented Jun 17, 2015

Uh oh!

WonderCsabo commented Jun 17, 2015

Uh oh!

yDelouis commented Jun 18, 2015

Uh oh!

WonderCsabo commented Jun 18, 2015

Uh oh!

yDelouis commented Jun 18, 2015

Uh oh!

WonderCsabo commented Jun 18, 2015

Uh oh!

WonderCsabo commented Jun 18, 2015

Uh oh!

WonderCsabo commented Jun 23, 2015

Uh oh!

yDelouis commented Jun 23, 2015

Uh oh!

WonderCsabo commented Jul 15, 2015

Uh oh!

yDelouis commented Jul 16, 2015

Uh oh!

WonderCsabo commented Jul 16, 2015

Uh oh!

yDelouis Sep 20, 2015

Choose a reason for hiding this comment

Uh oh!

WonderCsabo Sep 20, 2015

Choose a reason for hiding this comment

Uh oh!

yDelouis commented Sep 20, 2015

Uh oh!

WonderCsabo commented Sep 21, 2015

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants