Display All Routes Command? (rake routes equivalent)

[ragurney]

Hello,

Is there a command I can execute inside an application using this framework to display all of the routes Rest.li will define? I'm thinking of something similar to the output of rake routes:

          users GET  /users          {:controller=>"users", :action=>"index"}
formatted_users GET  /users.:format  {:controller=>"users", :action=>"index"}
                POST /users          {:controller=>"users", :action=>"create"}
                POST /users.:format  {:controller=>"users", :action=>"create"}

if not and if that's something that would be accepted, if someone could point me to where to start and perhaps some tips on how it could be implemented I'd be happy to open a PR!

[nickibi]

We do not have such support, but you are welcome to contribute for such feature.
You could introduce a gradle task, which can be used as a cmd tool.
All the routes information is exposed in the IDL files(restspec.json), eg: https://github.com/linkedin/rest.li/blob/7372bc76f7ce78007ecb24ca80f17399e5246e13/restli-tools/src/test/resources/idls/twitter-accounts.restspec.json. You could process the IDL files to achieve it. You can leverage RestSpecParser(https://github.com/linkedin/rest.li/blob/b8fadffc4b9d7369ef0da31dd93fab4a527665db/restli-tools/src/main/java/com/linkedin/restli/tools/clientgen/RestSpecParser.java) to process the IDL file.

[ragurney]

Great, thanks for the response @nickibi! I'll give it a shot!

[ragurney]

Could you walk me through the usual development cycle for new tasks?

I have a very rough skeleton for the new task here but I'm not sure how to get it running or how to use it on the example server.

[junchuanwang]

@ragurney
Hello, you will need some knowledge on gradle.

Basically your main project (the project which had a dependency on this rest.li library) need to add a line li-pegasus2 in itsbuild.gradle. Then the PegasusPlugin.java will take effect.

Then in your root folder, enter
./gradlew tasks --all. You are expected to see your task lists there.

Invoking that tasks will need
./grdlew <task-name>

[ragurney]

Got it thanks! I haven't had too much time to look at this but will try to dedicate some time on Friday to have another crack at it.

[abhishek1nair]

@ragurney were you able to figure this out. Was looking exactly this.

[ragurney]

Hi @abhishek1nair, I haven't found the time to be able to look into this further (I had a lot of issues getting RestLi to work locally). Was planning on getting back to it once I find the time, but haven't made much progress yet.