api documentation

Documenting and Publishing an API on Mashape

Hey Mashapers, We just launched our new version of Mashape (internally, we called it “Mashape 5″) not too long ago. In this new version, we’ve redesigned certain flows on the site which may be different from the previous version (“Mashape 4″). Specifically, we’ve revamped the API documentation design and changed it to a new 3-column layout. To help you guys out, we’ve written up a guide on how to document and publish an API on Mashape. API providers, what are you waiting for? Documenting and publishing your API is just 3 easy steps: Filling in the basic information to list your...

“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. You...

5 Steps to List / Add your API to Mashape

This is a tutorial on how to add your API(s) to Mashape.  Do note that things change quite often so if you’re reading this from the future, some things might have changed.  But we’ll update this as often as we can so everyone’s on the same page (literally!). Before we start, you would need a Mashape account.  (You can skip this part if you’ve done this already).  Go to http://www.mashape.com/ and click on the button in the upper-right hand section of the page that says “Join Us”.  You’ll also have the option to sign up using your GitHub account. After signing...

Mashape Public Launch. Now open to every Developer and API.

Hello Mashapers, We’re super excited to announce that we’re now officially open to public for every API and developer in the world. We’re now powering more than 400 APIs and thousands of developers are relying on Mashape APIs everyday. We can’t wait to hear your thoughts and feedback in the coming weeks. To be part of the movement, you can simply join us on Mashape. Hacker note: for developers who were using the Face.com API (for face detection), we now have an amazing free replacment created by Lambda Labs – http://www.mashape.com/lambda/face Mashape has also launched some useful features in the last year! For API providers: ready-to-go billing...

5 tips to designing an API the Right Way

Everyone is building APIs these days. Most new apps/services have some kind of API, and almost every app uses at least one API. I was hacking on a project a couple of years back, and I remember one of the developers on the project mentioning that we should have an API. At that time, I thought he was crazy. We have not even launched the product, why would anyone want to use our API, let alone our App? Our app eventually failed, mostly the fault of ourselves. We out grew it, moved on to bigger and better ventures, but looking back,...