Apiary

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….?

Working Principle

MOCK USE IMPLEMENTATION

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.

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

Goals & Features…

1. Quick API building 30 min’s2. Can be change in minutes3. Flexible and Collaborating API design4. Generated documentation5. Integrated code samples6. Debugging and Automated Testing7. Github Integratoin

Apiary Vs Other’s…

1. Swagger2. Apigility by zend Framework3. RAML4. sailscasts

implementcode

1. No real-time feed back while development.2. No Collaboration with users.3. No Instant API mock

APIBlueprintAPI Blueprint is a lightweight Web API documentation Markdown language.Open source & domain specific languageAPI 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

APIBlueprint Document Structure

+ Metadata

|

+

API Name & Overview Section

|... |

+

Resource Section | | | ... ...Layout of a resource section without a parent group:

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

APIBlueprint ParsersSnowcrash for APIBlueprintProtagonist for nodeJSsnowcrash-dot-net-wrapper for .net

Building snowcrash Parser

ON LINUXClone the repo + fetch the submodules:$ git clone --recursive git://github.com/apiaryio/snowcrash.git $ cd snowcrashBuild & test Snow Crash:$ ./configure $ make testTo include integration tests (using Cucumber) use the --include-integration-tests flag:$ ./configure --include-integration-tests $ make test

Building snowcrash Parser

ON WINDOWS1. Install Visual Studio Express 2012 for Windows Desktop2. 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 Apiary\snowcrash7. Run vcbuild.bat: vcbuild.bat8. Run Snow Crash tests: vbuild.bat test

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

tools…RSpec API Blueprint Auto generation of API documentationGenerate API Blueprint from request specs.Iglo Custom API blueprint formatterGenerate static HTML documentation from API Blueprint.Sublime Text plugin Parse API Blueprint with a hotkeyAPI 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.

tools…Aglio Custom API blueprint formatterRender HTML from API blueprint files, with support for custom themes. Executable and asynchronous Node.js library.Matter Compiler API Blueprint from YAML or JSONMatter 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 generatorGenerate a simple, fast mock server from an API Blueprint.API Blueprint Mock Server API Blueprint Mock Server in JavaRun a simple, fast mock server in Java from an API Blueprint. Plans for Android support in the future.

toolsAglio Custom API blueprint formatterRender HTML from API blueprint files, with support for custom themes. Executable and asynchronous Node.js library.Matter Compiler API Blueprint from YAML or JSONMatter 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 generatorGenerate a simple, fast mock server from an API Blueprint.API Blueprint Mock Server API Blueprint Mock Server in JavaRun a simple, fast mock server in Java from an API Blueprint. Plans for Android support in the future.