By on January 24, 2013

“Getting Started” section for your API

← Back to Blog Home

One of the top requests we get from API providers in Mashape is to add a section where they can go beyond just plain text when providing more in-depth information about their APIs (e.g. introduction, usage guidelines, sample codes, etc).  This requires a level of formatting that simply cannot be achieved with just plain text.

Also, having information in one place, as opposed to having several browser tabs open to read through the API usage information, can be quite a time-saver.

We have added a “Getting Started” section for your APIs in Mashape.  It supports GitHub Flavored Markdown.

Yoda Speak API - Getting started

Yoda Speak API – Getting started

Sample code in PHP

Sample code in PHP

You can check the example API above here.

Notice on the left navigation panel that a “Getting Started” section has been added. To add a “Getting Started” section for your own API, click on the “Admin” button in your API profile page and navigate to the “Getting Started” tab, like below:

Getting started section

Getting started section


Don’t forget to set your Markdown to Public once you’re done.

Set markdown to public

Set markdown to public

We hope that you will find this feature very useful when communicating the intended use for your API to developers.  We highly encourage everyone to try it out and provide us feedback on your experience with it.  Send us a message in Facebook, Twitter, or


Share Post: