Adds base api support via single-inheritance interfaces by codefromthecrypt · Pull Request #246 · OpenFeign/feign

codefromthecrypt · 2015-07-03T08:03:35Z

Before this change, apis that follow patterns across a service could
only be modeled by copy/paste/find/replace. Especially with a large
count, this is monotonous and error prone.

This change introduces support for base apis via single-inheritance
interfaces. Users ensure their target interface bind any type variables
and as a result have little effort to create boilerplate apis.

Ex.

@Headers("Accept: application/json")
interface BaseApi<V> {

  @RequestLine("GET /api/{key}")
  V get(@Param("key") String);

  @RequestLine("GET /api")
  List<V> list();

  @Headers("Content-Type: application/json")
  @RequestLine("PUT /api/{key}")
  void put(@Param("key") String, V value);
}

interface FooApi extends BaseApi<Foo> { }

interface BarApi extends BaseApi<Bar> { }

closes #133

codefromthecrypt · 2015-07-03T08:04:24Z

@alexeos @zampettim @jmgrimes @spencergibb @jdamick

@headers

Before this change, apis that follow patterns across a service could only be modeled by copy/paste/find/replace. Especially with a large count, this is monotonous and error prone. This change introduces support for base apis via single-inheritance interfaces. Users ensure their target interface bind any type variables and as a result have little effort to create boilerplate apis. Ex. ```java @headers("Accept: application/json") interface BaseApi<V> { @RequestLine("GET /api/{key}") V get(@Param("key") String); @RequestLine("GET /api") List<V> list(); @headers("Content-Type: application/json") @RequestLine("PUT /api/{key}") void put(@Param("key") String, V value); } interface FooApi extends BaseApi<Foo> { } interface BarApi extends BaseApi<Bar> { } ``` closes #133

cloudbees-pull-request-builder · 2015-07-03T08:14:59Z

NetflixOSS » feign » feign-pull-requests #129 SUCCESS
This pull request looks good

codefromthecrypt · 2015-07-12T22:12:20Z

This PR is sad nobody cares about it..

spencergibb · 2015-07-13T00:14:27Z

I like it! It would be useful for spring Cloud.

zampettim · 2015-07-13T12:58:27Z

I definitely like it, and look forward to testing it out. I'm not that used to using GitHub and their PR system, so it wasn't clear to me that you were done with the work you were doing. I apologize if that caused any confusion.

@spencergibb I'm using Feign via Spring Cloud. Do you have plans to pull this to a branch that I can test with, or should I just pull the feign branch itself?

spencergibb · 2015-07-13T15:18:48Z

@zampettim As soon as a Feign release is done with the PR, we can bring it into then next version of Spring Cloud Netflix.

spencergibb · 2015-07-13T15:22:12Z

@adriancole This would solve this SO

Adds base api support via single-inheritance interfaces

codefromthecrypt · 2015-07-13T16:52:00Z

8.6.0 on the way!

bstick12 · 2015-07-28T13:50:50Z

@adriancole Any chance this could get this merged back to 7.x?

codefromthecrypt · 2015-08-02T21:57:39Z

@bstick12 I'll try to backport this tomorrow morning. Sorry about the delay!

codefromthecrypt · 2015-08-03T19:50:18Z

@bstick12 v7.6.0 on the way

bstick12 · 2015-08-04T08:19:45Z

@adriancole Thanks very much.

lukosan · 2016-11-03T14:50:35Z

Can you remember if it was choice to make it only support single-inheritance or is there a fundamental reason why it couldn't or shouldn't support multilevel-inheritance? (or to put it another way: do you think it's worth my looking into making it support multilevel inheritance?)

codefromthecrypt · 2016-11-03T15:44:40Z

it was a decision to remove many of the edge cases: reflection, resolving methods that exist in multiple interfaces etc.

JiabaoZhu · 2017-09-18T12:36:36Z

@adriancole
Sorry, my english is not very good.
I have this problem at the moment, for example:

This code is automatically generated.

public interface TestApiAuto {
    @RequestLine("GET /health")
    String health();

    @RequestLine("GET /all")
    List<Entity> all();
}

This is custom code

public interface TestApi {
    @RequestLine("GET /custom")
    String custom();
}

Now write a client interface

@FeignClient(name = "test")
    public interface TestClient extends TestApi, TestApiAuto  {
}

The result is the wrong: "Only single inheritance supported: TestClient"
Why can't FeignClient support multilevel inheritance?

JiabaoZhu · 2017-09-18T12:42:25Z

Because TestApiAuto is automatically generated according to the database structure, when the database changes, it will regenerate the code, so some custom methods can not be written in it

Adds base api support via single-inheritance interfaces

codefromthecrypt force-pushed the adrian.base-api branch from 29191ae to b568814 Compare July 3, 2015 08:05

codefromthecrypt force-pushed the adrian.base-api branch from b568814 to 0aac921 Compare July 3, 2015 08:12

codefromthecrypt pushed a commit that referenced this pull request Jul 13, 2015

Merge pull request #246 from Netflix/adrian.base-api

64bda9d

Adds base api support via single-inheritance interfaces

codefromthecrypt merged commit 64bda9d into master Jul 13, 2015

codefromthecrypt deleted the adrian.base-api branch July 13, 2015 16:44

codefromthecrypt added this to the 8.6.0 milestone Jul 13, 2015

spencergibb mentioned this pull request Jul 13, 2015

Update feign version to 8.6.0 to support interface hierarchies spring-cloud/spring-cloud-netflix#436

Closed

dinocop mentioned this pull request Sep 11, 2015

feign support of interface hierarchies ignores MVC annotation on type spring-cloud/spring-cloud-netflix#537

Closed

velo pushed a commit that referenced this pull request Oct 8, 2024

Merge pull request #246 from Netflix/adrian.base-api

9e7ebc6

Adds base api support via single-inheritance interfaces

Uh oh!

Conversation

codefromthecrypt commented Jul 3, 2015

Uh oh!

codefromthecrypt commented Jul 3, 2015

Uh oh!

cloudbees-pull-request-builder commented Jul 3, 2015

Uh oh!

codefromthecrypt commented Jul 12, 2015

Uh oh!

spencergibb commented Jul 13, 2015 via email

Uh oh!

zampettim commented Jul 13, 2015

Uh oh!

spencergibb commented Jul 13, 2015

Uh oh!

spencergibb commented Jul 13, 2015

Uh oh!

codefromthecrypt commented Jul 13, 2015

Uh oh!

bstick12 commented Jul 28, 2015

Uh oh!

codefromthecrypt commented Aug 2, 2015

Uh oh!

codefromthecrypt commented Aug 3, 2015

Uh oh!

bstick12 commented Aug 4, 2015

Uh oh!

lukosan commented Nov 3, 2016

Uh oh!

codefromthecrypt commented Nov 3, 2016 via email

Uh oh!

JiabaoZhu commented Sep 18, 2017

Uh oh!

JiabaoZhu commented Sep 18, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants