Substeps Api Viewer

[Andrew Lee]

Hi all,

I wanted to share what we have been doing for generating glossaries for our substep implementations.

You can see an example of a generated API report for the substeps-webdriver steps here:

  http://plasma147.github.com/api-viewer/#/

I did this by providing a new implementation of the GlossaryPublisher that writes a json representation of the glossary to a file:

  https://gist.github.com/4068700


The report viewer is just a single page html app that loads the generated report as a service call.
The viewer can be found as a standalone project here:

  https://github.com/plasma147/api-viewer/

We integrated this into jenkins (as a report) to give our testers a single place to reference and that way it's always up to date as we add new Substep definitions to the build.

We're still looking into other ways of making it a bit more accessible for our testers but this helps a bit.
 
Cheers,
Andy