Adding Try it out option in slate

[shwethashankar]

Hi Team ,
How can we add try it out option in slate so that we can execute API and show response in console like swagger?

[MasterOdin]

Is there a good example of a three column API docs that has this? I'd like to draw some inspiration for design ideas before writing something up here.

[mephisto101]

Would be nice to implement the "Try it" into the right pane alongside code examples.

Can't remember having seen api docs doing it that way.
Maybe let's do some brain storming on ideas here @MasterOdin ?

[shwethashankar]

@mephisto101 rebilly has some nice Try it option enabled in - https://api-reference.rebilly.com/tag/Customers/

[mephisto101]

To be fair that is built with ReDocly not slate

[MasterOdin]

I am struggling with how one might define a "Try it now" block within the markdown. Does every section get one? How do we define the generic parameters required on each request (e.g. API key) vs the specific parameters for that method?

[mephisto101]

@MasterOdin the most common approach with other API doc tools is to offer fields to control variables in the center column which will the get use in the right column within the code examples section

I do agree that the way Spotify is doing this within the right column seems like a good approach though.
It would be overall very helpfull to be able to offer a "Try it" feature in the right column to third parties can familiarise themselves with once APIs righ from the docs by running examples using any credentials they receiced and any examples that might be meaningful to them as that is usually easier to understand as less abstract tothe third party than a static code example which they don't know.

[shwethashankar]

Spotify has the "Try it" option enabled with three column API doc
https://developer.spotify.com/console/get-album-tracks/