Apiary.io is a hosted suite of tools that helps companies quickly build, test, and monitor their web APIs. It allows designing and collaborating on API blueprints, generates documentation and mock APIs, and provides real-time debugging and testing. API blueprints use Markdown syntax with extensions to define resources, parameters, headers, and requests/responses. Various open-source tools can parse and process API blueprints.

1. Apiary

2. Apiary.io is a hosted suite of tools that help
companies build web API’s quickly, test &
monitor them.
Apiary is the "GitHub for APIs"—the next-
generation API platform, helping companies
design, build, market and support APIs more
efficiently.
What is Apiary….?

3. Working Principle
MOCK USE IMPLEMENTATION

4. Once you design initial blueprint for your API,
Auto generated testing interfaces and
documentation provides an interactive way for
your intended API consumers to play with API
Interface, while providing you with an
inspector for you to monitor interactions with
API, while debugging and providing feed-back
in real-time.

5. • Allowing you to efficiently build exactly the
API they need before investing too many
resources into development.

6. Goals & Features…
1. Quick API building 30 min’s
2. Can be change in minutes
3. Flexible and Collaborating API design
4. Generated documentation
5. Integrated code samples
6. Debugging and Automated Testing
7. Github Integratoin

7. Apiary Vs Other’s…
1. Swagger
2. Apigility by zend Framework
3. RAML
4. sailscasts
implementcode
1. No real-time feed back while development.
2. No Collaboration with users.
3. No Instant API mock

8. APIBlueprint
API Blueprint is a lightweight Web API
documentation Markdown language.
Open source & domain specific language
API Blueprint is essentially a set of semantically
assumption on top of a Markdown syntax that are
used to define a Web API.
In additional to regular Markdown syntax API
Blueprint inherits some GitHub Flavored Markdown
features and uses some parts of MultiMarkdown
syntax.
Core of self-service solution

9. APIBlueprint
Document Structure
+ Metadata
|
+
API Name & Overview Section
|... |
+
Resource Section | | | ... ...
Layout of a resource section without a parent group:

10. + Metadata
|
+ API Name & Overview Section
|
+ Resource Group Section
| |
| + Resource Section
| | |
| | + Parameters Section
| | |
| | + Headers Sections
| | |
| | + Resource Model Section
| | | |
| | | ...
| | |
| | + Action Section
| | | |
| | | + Parameters Section
| | | |
| | | + Headers Sections
| | | |
| | | + Request Section
| | | | + Headers Section
| | | | |
| | | | + Body Section
| | | | |
| | | | + Schema Section
| | | |
| | | + Response Section
| | | |
| | | + Headers Section
| | | |
| | | + Body Section
| | | |
| | | + Schema Section
| | |
| | + Action Section
| | | |
| | | ...
| | ...
| |
| + Resource Section
| | |
| | ...
| ...
|
+ Resource Group Section

11. APIBlueprint Parsers
Snowcrash for APIBlueprint
Protagonist for nodeJS
snowcrash-dot-net-wrapper for .net

12. Building snowcrash Parser
ON LINUX
Clone the repo + fetch the submodules:
$ git clone --recursive git://github.com/apiaryio/snowcrash.git
$ cd snowcrash
Build & test Snow Crash:
$ ./configure
$ make test
To include integration tests (using Cucumber) use the --include-
integration-tests flag:
$ ./configure --include-integration-tests $ make test

13. Building snowcrash Parser
ON WINDOWS
1. Install Visual Studio Express 2012 for Windows Desktop
2. Install Python 2.7
3. Install Git
4. Clone apiaryio/snowcrash using GitHub client or git in Git Shell
5. Update the submodules using git submodule update --init Open
Command Prompt and change directory (cd) to Snow Crash e.g.:
6. Open Command Prompt and change directory (cd) to Snow Crash e.g.:
cd Apiarysnowcrash
7. Run vcbuild.bat: vcbuild.bat
8. Run Snow Crash tests: vbuild.bat test

14. tools…
Apiary.io REST API Platform See, write and share
APIs
Apiary supercharges your Blueprints with interactive
documentation, API mock, test suites, validations,
traffic inspector and collaboration.
Dredd API Blueprint testing tool
Plug your API Blueprint into the CI and get no more
outdated API documentation.
cURL trace parser A HTTP introspection tool
Record HTTP communication directly in the API
Blueprint format.

15. tools…
RSpec API Blueprint Auto generation of API
documentation
Generate API Blueprint from request specs.
Iglo Custom API blueprint formatter
Generate static HTML documentation from API
Blueprint.
Sublime Text plugin Parse API Blueprint with a
hotkey
API Blueprint syntax highlighting, live validation and
parsing in your favorite text editor.
?< your tool here >
To share your API Blueprint tool fork this repository,
add the tool to this listing and create a pull-request.

16. tools…
Aglio Custom API blueprint formatter
Render HTML from API blueprint files, with support
for custom themes. Executable and asynchronous
Node.js library.
Matter Compiler API Blueprint from YAML or JSON
Matter Compiler is an API Blueprint AST to API
Blueprint conversion tool. It composes an API
blueprint from its serialized AST media-type.
Contractor Mock server generator
Generate a simple, fast mock server from an API
Blueprint.
API Blueprint Mock Server API Blueprint Mock
Server in Java

17. tools
Aglio Custom API blueprint formatter
Render HTML from API blueprint files, with support
for custom themes. Executable and asynchronous
Node.js library.
Matter Compiler API Blueprint from YAML or JSON
Matter Compiler is an API Blueprint AST to API
Blueprint conversion tool. It composes an API
blueprint from its serialized AST media-type.
Contractor Mock server generator
Generate a simple, fast mock server from an API
Blueprint.
API Blueprint Mock Server API Blueprint Mock
Server in Java