Separate APIs for the world and internal use?

Question

I have built an application in Ruby on Rails where I exposed various services via APIs from my backend. The controllers for these are in a directory called ../app/v1.

Now I am planning to allow other developers to be able to built apps on top of mine and thus need to allow them to access my functionalities.

What is the best way to do this?

Should I create a new folder /app/v2 and write more controllers to expose APIs from my backend dedicated to the these developers?

I am wondering if this will violate the Don't Repeat Yourself principle but at the same time am conscious about not exposing irrelevant functionality.

Please advise. Also, I am using doorkeeper gem and planning to use grape gem for this v2 APIs. Do feel free to share if you think this is wise/unwise.

Are you planing to do some extra functionality for other API end point ? — Md Sirajus Salayhin, Aug 12 '15 at 10:21

score 1 · Answer 1 · edited May 23 '17 at 12:06

1

If you want to add new and more functionality we can add this to your controller rather then API folder. To maintain DRY you can use concern feature of rails 4.

Please check this answer about how to use concern.

How to use concerns in Rails 4

edited May 23 '17 at 12:06

Community

1
1

answered Aug 12 '15 at 10:33

Md Sirajus Salayhin

4,246
5
30
44

Thanks, how about exposing the APIs via OAuth 2.0, should I maintain a separate v1, v2 directory? – Roy Aug 12 '15 at 10:41
You don't need to separate directory, you just create different method for that. – Md Sirajus Salayhin Aug 12 '15 at 10:43
Got it, then for my current functionalities, what do I do to prevent some of them being exposed at all? – Roy Aug 12 '15 at 10:45
You mean get access of some function ? – Md Sirajus Salayhin Aug 12 '15 at 10:47
Yes, in my current set - I only want to allow access to some – Roy Aug 12 '15 at 10:48
You can use cancan gem (https://github.com/ryanb/cancan) to restrict control over your functions to access. – Md Sirajus Salayhin Aug 12 '15 at 10:49

Separate APIs for the world and internal use?

1 Answers1