Export list of API Paths from OpenAPI spec using swagger ui

Question

I have a bunch of APIs that are documented as OpenAPI v3 specs.

Eg: foo.yaml, bar.yaml and baz.yaml

I also have a Web server that displays the specs in the swagger ui, so all my swagger models are easily consumable by devs, designers and so on.

My question: is there an easy way, using the javascript console, to give me a list of the resource paths?

I've had a quick look around the swagger ui source code but couldn't find anything useful, other than the SwaggerUIBundle object.

Helen · Accepted Answer · 2020-01-28 08:18:14Z

2

The API definition is accessible via ui.specSelectors.specJson(). The value is an Immutable.js Map.

You can use the following code to list all the paths:

let paths = ui.specSelectors.specJson().get("paths")
paths.mapKeys(key => console.log(key))

answered Jan 28, 2020 at 8:18

Helen

99.8k17 gold badges280 silver badges352 bronze badges

Sign up to request clarification or add additional context in comments.

1 Answer 1