Instead of manually redefine the route for the action, retrieve it from the routes of the application. #187

mtparet · 2014-01-23T08:41:26Z

Description

Instead of manually redefine the route for the action, retrieve it from the routes of the application.
This enable also to have only place where to maintain the routing.

Example:

Instead of defining the name, HTTP verb, and route of the action.

api :POST, "/users", "Create user"

You could now just define the name of the action.

api! 'Create user'

HTTP verb and route will be retrieved from the routes of the application.

iNecas · 2014-01-23T09:22:28Z

Hi, You are my hero!

Having multiple routes to one method is the case quite often. What about having also

api_routes desc

that would add all the routes for the method? This way, the devs have option if one route is
enough, all they want all of them. Thoughts?

iNecas · 2014-01-23T09:26:50Z

Also, maybe we could do this

api "Create user"

Since the method and path were not defined, we would load them from the routes. What about that?

Pajk · 2014-01-23T13:27:17Z

Great feature, thanks for contribution 👍. We have been thinking about this since the beginning.

mtparet · 2014-01-23T17:43:53Z

Thank you so much guys!

@iNecas I'm trying to add all the routes for one action, but I'm not sure how should I do, any thoughts ? https://github.com/Pajk/apipie-rails/pull/187/files#diff-3794160d9a3652a5e62136ca6ebc4f91R326

Do you see an inconvenient to add all routes for an action by default ?

mtparet · 2014-01-24T07:59:10Z

@iNecas for now, I removed the work in progress to support multiple routes for one action. I prefer to do it in another PR once this one will be merged (and used by people ?).

mtparet · 2014-01-27T16:47:33Z

Tests failing for Rails 3.0.0, do we really want to support a deprecated Rails version ?

iNecas · 2014-01-27T17:54:25Z

We can at least try figure out what's won't be working. So we can put into the tests condition on the rails version, something like:

unless Rails::VERSION::STRING < '3.2.0'

end

So we would be able to say at least, that specific features doesn't work with old rails. I have not hard requirement on supporting rails 3.0, but since so far apipie was working on it, some folks might consider it as advantage.

iNecas · 2014-01-27T17:56:04Z

in ideal case, we would go with deprecation warning with the next release (I would say it's time for 0.1.0 version finally :) and remove the support next version (I don't have issues with release 0.2.0 quite soon, just to drop the support.

mtparet · 2014-01-27T20:16:09Z

So i'll go for Rails::VERSION::STRING < '3.2.0' :)

AlekSi · 2014-01-28T11:14:26Z

👍

iNecas · 2014-01-28T13:52:40Z

I've checked the PR, hit some issues with Sprockets routes (fixed), also looked into possibility of loading all matching routes and using api keyword when not specifying the vert/path.

What do you think about #194 ?

mtparet · 2014-01-28T14:06:30Z

Thanks, I'm checking this now.

mtparet · 2014-01-28T14:30:05Z

#194 looks good for me 👍

mtparet · 2014-02-28T21:33:27Z

@iNecas what do you think about the state of this feature ? (ie: is it mergeable?)

iNecas · 2014-03-03T13:04:17Z

Hi, I have maybe a bit more flexible way how to define the customization in loading the routes for the "end user", I hope to get that in code sometimes this week. Sry for delay!

mtparet · 2014-07-26T21:04:56Z

@iNecas sorry to bother you, what are your last thoughts about this PR? I'm willing to help on this side so let me know :)

iNecas · 2014-07-26T22:21:24Z

lib/apipie/application.rb

+            method.to_s == route.defaults[:action]
+      end
+
+      routes.map do |route|


I wonder if the routes_path_formatter (or routes_formatter) shouldn't be a class/object, that would take the array of routes and return the array of the {path: path, verb: '...'}. The reason is the case, whe you would like for some reason for example change the order of api keywords.

What about the default formater class similar to this:

class RoutesFormater def format_paths(paths) paths.map { |path| format_path(path) } end def format_path(path) { path: "", verb: "" } end end

It would allow to:

customize the order of the routes if needed

skip some routes from getting to the documentation

add things like automatic description of the api, if needed

What do you think?

iNecas · 2014-07-26T22:22:28Z

@mtparet I really appreciate your patience. Thanks for reviving this PR. One final thought about the interface for the custom formatter.

iNecas · 2014-08-29T08:23:48Z

@mtparet I hope I didn't put you off just yet…

mtparet · 2014-08-29T08:33:35Z

@iNecas nope, I was on vacation these last weeks and has to catch up some works this week. I hope to have time next week to finalize this one :)

mtparet · 2014-11-04T09:34:31Z

Just rebased and introduced routes formatter class.
(see comment about one questioning)

mtparet · 2014-11-04T09:39:52Z

lib/apipie/dsl_definition.rb

-        _apipie_dsl_data[:api_args] << [method, path, desc, options]
+        _apipie_dsl_data[:api] = true
+        case args.size
+        when 0..1


Since we introduced another argument options, if we want to allow pass it here, we should check size between 0 and 2 but this overlaps with the below check between 2 and 4.
So it means we should use another way to distinguish the two possibility to define routes.

I wonder, if api! would not make that difference easier: so that we would not be limited on the number of arguments

iNecas · 2014-11-10T08:54:00Z

It's shaping really nicely, some comments inline

…utes

(from route or not) so for now, we can't use options when using routes.rb definition

mtparet · 2014-12-08T15:06:55Z

just rebased against master

iNecas · 2014-12-16T15:40:24Z

lib/apipie/routes_formatter.rb

@@ -0,0 +1,39 @@
+class RoutesFormater


Should be namespaced under Apipie module

@mtparet no action needed: I will fix that with some other updates I will probably have when testing against my apps

Good catch, I forgot to encapsulate it under the module.

Ability to specify the formatter thought the configuration and influence the other +api+ paramters (such as desc) form the formatter.

Adding a recursion for getting routes form mounted engines. Also checking if we need to add the api_base_url to the path instead of removing the api_base_url when loading the path from routes: doesn't play well with inheritance of api_base_url.

iNecas · 2014-12-17T15:39:21Z

@mtparet I've opened a PR into your branch with my changes ifeelgoods#2, feel free to commend on them. After getting those changes in, I'm ok with merging this into master and releasing 0.3.0 next week.

mtparet · 2014-12-17T15:40:24Z

Thanks a lot @iNecas, I'll take a look and merge it in my branch.

Ifeelgoods generate api route

iNecas · 2014-12-18T08:58:46Z

Merging now! Thanks @mtparet for all the work and patience. I expect to release 0.3.0 sometimes next week.

Instead of manually redefine the route for the action, retrieve it from the routes of the application.

mtparet · 2014-12-18T08:59:32Z

Nice!

iNecas · 2015-01-07T14:32:33Z

I'm happy to announce that the new version 0.3.0 was released, including this change. Thanks for making that happen https://github.com/Apipie/apipie-rails/blob/master/CHANGELOG.md#v030

This was referenced Feb 10, 2014

api keyword without specifying the verb/path loads values from routes #194

Closed

Add Code Climate badge #205

Closed

iNecas mentioned this pull request Mar 4, 2014

[Fixes #125] Dump examples as json #130

Merged

iNecas reviewed Jul 26, 2014
View reviewed changes

mtparet force-pushed the generate_api_route branch from d2ce160 to 59febee Compare November 4, 2014 09:32

mtparet reviewed Nov 4, 2014
View reviewed changes

mtparet force-pushed the generate_api_route branch from f293ea1 to 2755b11 Compare December 1, 2014 11:31

Matthieu Paret and others added 15 commits December 8, 2014 16:03

update README

ef29856

fixes for rails 3.0

6cfc144

api keyword without specifying the verb/path will load values from ro…

2784d61

…utes

In-depth search for the route controller

701c76b

Fix removing parenthesis

7e90332

possiblity to define a custom route formatter

dbfc1f8

default option to empty hash

1bf2c68

argument size can't anymore defined which way we are using

1fcefab

(from route or not) so for now, we can't use options when using routes.rb definition

add routes formatter

cd04c2c

no need to keep compability with rails 3.0 anymore

6069885

fix max number agument

38a61b5

use api! to define from routes.rb

1247a91

use a subclass for the formatter

48ab3f4

Update README.rst

2f3bba8

add default formatter

11ce9cc

mtparet force-pushed the generate_api_route branch from e9bdaa2 to 11ce9cc Compare December 8, 2014 15:06

iNecas reviewed Dec 16, 2014
View reviewed changes

iNecas added 3 commits December 17, 2014 16:25

More customizable RoutesFormatter

48bfe6c

Ability to specify the formatter thought the configuration and influence the other +api+ paramters (such as desc) form the formatter.

Support for loading routes from engines

d35e0a1

Adding a recursion for getting routes form mounted engines. Also checking if we need to add the api_base_url to the path instead of removing the api_base_url when loading the path from routes: doesn't play well with inheritance of api_base_url.

Distinguish between api from routes and the others

170454d

Merge pull request #2 from iNecas/ifeelgoods-generate_api_route

e494e62

Ifeelgoods generate api route

iNecas added a commit that referenced this pull request Dec 18, 2014

Merge pull request #187 from ifeelgoods/generate_api_route

4627d69

Instead of manually redefine the route for the action, retrieve it from the routes of the application.

iNecas merged commit 4627d69 into Apipie:master Dec 18, 2014

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Instead of manually redefine the route for the action, retrieve it from the routes of the application. #187

Instead of manually redefine the route for the action, retrieve it from the routes of the application. #187

mtparet commented Jan 23, 2014

iNecas commented Jan 23, 2014

iNecas commented Jan 23, 2014

Pajk commented Jan 23, 2014

mtparet commented Jan 23, 2014

mtparet commented Jan 24, 2014

mtparet commented Jan 27, 2014

iNecas commented Jan 27, 2014

iNecas commented Jan 27, 2014

mtparet commented Jan 27, 2014

AlekSi commented Jan 28, 2014

iNecas commented Jan 28, 2014

mtparet commented Jan 28, 2014

mtparet commented Jan 28, 2014

mtparet commented Feb 28, 2014

iNecas commented Mar 3, 2014

mtparet commented Jul 26, 2014

iNecas Jul 26, 2014

iNecas commented Jul 26, 2014

iNecas commented Aug 29, 2014

mtparet commented Aug 29, 2014

mtparet commented Nov 4, 2014

mtparet Nov 4, 2014

iNecas Nov 10, 2014

iNecas commented Nov 10, 2014

mtparet commented Dec 8, 2014

iNecas Dec 16, 2014

iNecas Dec 16, 2014

mtparet Dec 16, 2014

iNecas commented Dec 17, 2014

mtparet commented Dec 17, 2014

iNecas commented Dec 18, 2014

mtparet commented Dec 18, 2014

iNecas commented Jan 7, 2015

Instead of manually redefine the route for the action, retrieve it from the routes of the application. #187

Instead of manually redefine the route for the action, retrieve it from the routes of the application. #187

Conversation

mtparet commented Jan 23, 2014

Description

Example:

iNecas commented Jan 23, 2014

iNecas commented Jan 23, 2014

Pajk commented Jan 23, 2014

mtparet commented Jan 23, 2014

mtparet commented Jan 24, 2014

mtparet commented Jan 27, 2014

iNecas commented Jan 27, 2014

iNecas commented Jan 27, 2014

mtparet commented Jan 27, 2014

AlekSi commented Jan 28, 2014

iNecas commented Jan 28, 2014

mtparet commented Jan 28, 2014

mtparet commented Jan 28, 2014

mtparet commented Feb 28, 2014

iNecas commented Mar 3, 2014

mtparet commented Jul 26, 2014

iNecas Jul 26, 2014

Choose a reason for hiding this comment

iNecas commented Jul 26, 2014

iNecas commented Aug 29, 2014

mtparet commented Aug 29, 2014

mtparet commented Nov 4, 2014

mtparet Nov 4, 2014

Choose a reason for hiding this comment

iNecas Nov 10, 2014

Choose a reason for hiding this comment

iNecas commented Nov 10, 2014

mtparet commented Dec 8, 2014

iNecas Dec 16, 2014

Choose a reason for hiding this comment

iNecas Dec 16, 2014

Choose a reason for hiding this comment

mtparet Dec 16, 2014

Choose a reason for hiding this comment

iNecas commented Dec 17, 2014

mtparet commented Dec 17, 2014

iNecas commented Dec 18, 2014

mtparet commented Dec 18, 2014

iNecas commented Jan 7, 2015