Beautify API JSON during development

[ashmaroli]

Simplify reading API in development by outputting JSON tree view eliminating the need for browser
add-ons for Chrome and Firefox

Before

{ "collections_api": "http://localhost:4000/_api/collections",  "configuration_api": 
"http://localhost:4000/_api/configuration",  "data_api": "http://localhost:4000/_api/data",
 "pages_api": "http://localhost:4000/_api/pages",  "static_files_api": 
"http://localhost:4000/_api/static_files"}

After

{
  "collections_api": "http://localhost:4000/_api/collections",
  "configuration_api": "http://localhost:4000/_api/configuration",
  "data_api": "http://localhost:4000/_api/data",
  "pages_api": "http://localhost:4000/_api/pages",
  "static_files_api": "http://localhost:4000/_api/static_files"
}

[ashmaroli]

Additional beautification with the neatjson gem if you don't mind additional dependency

{
  "collections_api"    :  "http://localhost:4000/_api/collections",
  "configuration_api"  :  "http://localhost:4000/_api/configuration",
  "data_api"           :  "http://localhost:4000/_api/data",
  "pages_api"          :  "http://localhost:4000/_api/pages",
  "static_files_api"   :  "http://localhost:4000/_api/static_files"
}

[benbalter]

Nice. I believe you can accomplish this without monkeypatching by using the Sinatra:JSON API to specify the encoder: http://www.sinatrarb.com/contrib/json.html#label-Encoders

[ashmaroli]

you can accomplish this without monkeypatching

I opted to monkeypatch instead, because with this, the switch is located at one place, rather than having to repeat the custom encoder at all end-points.

[mertkahyaoglu]

Is this good to go?

[benbalter]

the switch is located at one place, rather than having to repeat the custom encoder at all end-points.

Couldn't you include it once in `server.rb?

[ashmaroli]

Couldn't you include it once in server.rb?

@benbalter Yes. Ultimately, the :json method gets patched when RACK_ENV == "development". I felt the approach in this PR leaves a cleaner footprint: server.rb wont have a native :json method defined in the release candidate version.

[mertkahyaoglu]

I liked the idea 👍 But this might be a little bit overkill for a feature that will be available for only development. I think it is better to keep the api minimal (less files, less modules etc.). That might be the reason @benbalter suggested not to monkey-patch an extra module.

[ashmaroli]

I restricted it to just development to keep the extra \n out of production API since only a handful of users might even look to read API output from the gem.

¯\_(ツ)_/¯