“Getting Started” section for your API

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 support@mashape.com

LIST API NOW

About

Mashape is the largest API hub in the world where you can consume, distribute, monitor and monetize your public and private APIs. Mashape powers 10,000 public & private APIs in every major industry, including finance, healthcare, and entertainment. We’re a Series A startup backed by Jeff Bezos (Amazon), Eric Schmidt (Google), Stanford University and top tier VC firms including Index Ventures, NEA and CRV.

Introducing API Glossary by Mashape

  When it comes to APIs, there’s a lot of jargon out there. The meaning of certain terms isn’t always obvious, and API providers sometimes use different ones to

OpenSSL Update – Mashape not vulnerable to Heartbleed

On Monday April 7th OpenSSL released an update to address CVE-2014-0160 (aka Heartbleed). This was a vulnerability in the popular cryptographic library that is used to secure many major

Mashape Revenue Share Fees Down 5%. Effective now!

Hello Mashape community, We’re happy to announce a reduced revenue share percentage rate. Going forward monetized APIs will only be charged a 20% revenue share. With ❤. As always, Mashape

Announcing The World’s Largest API Directory – PublicAPIs.com

We know how hard it is to find great APIs. So we built PublicAPIs.com, an API directory where you can instantly search through thousands of APIs and discover public cloud web services. Here’s