REST API documentation.
Reimagined.

It takes more than a simple HTML page to
thrill your API users. The right tools take weeks
of development. Weeks that apiary.io saves.

How does it work?

1

Describe
your API.

1
2
3
4

5
6
7
8
9
10
11
12

13
HOST: http://shop.acme.com/
--- Sample API v2 ---
---
Welcome to our API. Comments support [Markdown](http://daringfireball.net/projects/markdown/syntax) syntax.
---
-- Shopping Cart Resources --
GET /shopping-cart
> Accept: application/json
< 200
< Content-Type: application/json
{ "items": [
    { "url": "/shopping-cart/1", "product":"2ZY48XPZ", "quantity": 1, "name": "New socks", "price": 1.25 }
  ] }
Simple, Markdown inspired, DSL. Have a look at syntax.

Get everything in an instant!

2

  • Documentation

    Organized around resources, code samples with syntax highlight, easy to explore.

  • Inspector

    Users can make API calls through apiary.io, we show them how they differ from documentation.

  • Community

    Opensource your API documentation on GitHub. The right channel between developers on both side of the API.

  • Always Tested
    closed alpha

    The documentation is always watching your real API and tells you whenever it gets out of sync.

3

Happy developers. Party.

Still in doubt? Let our caffeinated developer show you!

What else does it do?

  • Server Mock

    The fastest way to static API prototype—just ‘document’ your future API and it’s up. 2 minutes to Hello World.

  • GitHub Integration

    Store the API Blueprint in your repository, everything gets updated as soon as you commit a new version.

  • I/O Validation

    Add a JSON Schema to the API Blueprint and the proxy will help your API users understand implementation of data structures better.

  • Customization
    closed alpha

    The documentation and tools can be seamlessly placed on your website and gray-labeled so the friction is close to none.

Save yourself some time and make your API easy to use.

Still in beta
and free!

Big player? Please, get in touch before you fry our servers.

Node Knockout Hackathon Winner Badge Springboard Summer 2011 Badge

Early prototype of the application (former WrathJS) won a first Node Knockout
hackathon as a most useful application.

The company went through startup accelerator programme Springboard in Cambridge (UK),
which is a part of Global Accelerator Network (TechStars Network).