Using external OpenAPI specs #

This page describes how you can easily use Slingshot with your OpenAPI spec if you're hosting one publicly on the web, or if you have a local spec you want to use.

Import external spec #

If you host an OpenAPI spec externally and want to create a HTML link that allows users to immediately import the OpenAPI spec into Slingshot, all you need to do is create a link like this:

https://s.requestbite.com?import={url-to-spec}

Let's say you have your OpenAPI spec at example.com/openapi.yaml, then you would create a link like this:

https://s.requestbite.com?import=https://example.com/openapi.yaml

View external spec #

Slingshot supports rendering OpenAPI specs as beautifully styled documentation in your browser. To render such a page, go to https://s.requestbite.com/openapi and paste the link to your publicly available spec in the modal that shows up.

You can also create a HTML link directly to the viewer like this:

https://s.requestbite.com/openapi/spec={url-to-spec}

Let's say you have your OpenAPI spec at example.com/openapi.yaml, then you would create a link like this:

https://s.requestbite.com/openapi?spec=https://example.com/openapi.yaml

Import local spec #

To import an OpenAPI spec that you have available locally on your computer, you need to manually go to https://s.requestbite.com and click Import > OpenAPI spec.. in the top-left corner. In the modal that shows up, you can pick the OpenAPI file from your browser's file picker.

We do, however, highly recommend that you install RBite CLI. By doing so, you can run:

rbite-proxy --enable-local-files

... and then you configure Slingshot to use your locally running proxy. By doing so, you get a file browser directly in the webapp when you click Import > OpenAPI spec...