Using the Markdown Button

If you are an API provider, and you want to help your users use your API in their favorite format, Console.REST comes as button that can be included in your projects on GitHub.

Simple Example

[![Run API With...](https://console.rest/github.io/assets/buttons/run_with_red.svg)](https://console.rest/#?uri=https%3A%2F%2Fapi.apis.guru%2Fv2%2Fspecs%2Fxkcd.com%2F1.0.0%2Fswagger.yaml)

API Description

For more information about which arguments can be passed in the url, please read the section What to put in the url.