Output JSON list of stories for 3rd party integration

Is your feature request related to a problem? Please describe.

I was looking to use the list of stories in a 3rd party tool. Unfortunately, I don’t see any documented way to get the stories list.

This issue has been brought up before, but closed before implemented:

• #775
• #3847
• #4878

Describe the solution you’d like

A URL in the Storybook site like /stories.json that includes a list of all the stories on the site. Maybe the same information that is available from the storySort function.

• unique id (token used in URL?)
• kind
• name
• parameters
• URL

Describe alternatives you’ve considered

Scraping the navbar of the Storybook.

Are you able to assist bring the feature to reality?

If I can figure it out, yes.

[ndelangen]

In 6.0.0 the storybook CLI will have a command:

sb extract

Which will generate a stories.json

https://github.com/storybookjs/storybook/blob/4a3d16103656a78b9fb377107bb755d2de80a7fb/lib/cli/src/generate.js#L70-L79

[alexbchr]

Tried running the mentioned sb extract command like so with latest version of the CLI and it worked great! It outputs a stories.json file in the Storybook build directory.

Command:

npx -p @storybook/cli@6.0.0-rc.16 sb extract
// Or equivalent taking automatically latest Storybook CLI version
npx -p @storybook/cli@next sb extract