documentation

Document and Data Merge Solution, WebMerge, Joins Mashape

So you’ve just finished writing your document, but you need to add supporting data.  Use WebMerge.  The newest API to join Mashape is an amazing tool that lets you easily combine documentation and data sets, and share the customized document internally or with 3rd party users. WebMerge will become an invaluable tool for your team to manage and create new documents, and perform merges.  Also, with customizable account settings, users can restrict permission to selected documents. The WebMerge REST API allows 3rd party applications to pull and integrate document and data routing information into their system; then send data to...

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

We Heard You Like Documentation, So We Put Docs in Your Docs

It’s a pain to keep different versions of API documentation up to date and synchronized, so we are rolling out a new feature: Embedded Documentation from Mashape. If you are an API provider, you can embed the documentation of an API on Mashape to your website using our embed code. Here’s how: 1) Go to your API Admin/Documentation 2) Copy and Paste the Code onto your website For now it’s static. Dynamic test console is coming soon, stay tuned! -Dali...

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,...

Your app now has an API, automatically.

Applications created on Mashape can be included into other apps created on the platform, but their components can be also called from the outside using our API infrastructure. This means that a published application has its own APIs and also the client libraries to call them using different popular technologies. For example, your app can be called from: Web Applications Desktop Applications Native Mobile Applications Wherever it’s required Your app is programmable inside and outside Mashape from day 1! You don’t have to care about building the wrappers around the APIs, it’s our job. And also, the Mashape Client libraries allow...

What to write in a great technical documentation?

We came across this article by Jacob Kaplan-Moss titled “What to write“. The article shares some great tips on writing great technical documentation. We’ve reproduced some parts of the article and summarized some main points below which we think would be the most useful for Mashapers. Formats of a technical documentation A well-documented project needs to provide many different forms of documentation. At a high level, you can break down the different types of technical documentation you need to provide into three different formats: Step-by-step tutorials, Overviews and topical guides to the various conceptual areas of your project, and Low-level, deep-dive reference material. Tutorials Good tutorials...