API Blueprint Parser
Branch: master
Clone or download
Pull request Compare This branch is 1 commit ahead of apiaryio:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ext/markdown-parser
snowcrash.xcodeproj
snowcrash.xcworkspace
src
test
tools
.clang-format
.gitignore
.gitmodules
.travis.yml
LICENSE
Makefile
README.md
appveyor.yml
common.gypi
configure
snowcrash.gyp
vcbuild.bat

README.md

logo

Snow Crash Build Status Build status

API Blueprint Parser

Snow Crash is the reference API Blueprint parser built on top of the Sundown Markdown parser.

API Blueprint is Web API documentation language. You can find API Blueprint documentation on the API Blueprint site.

Status

Use

C++ library

#include "snowcrash.h"

mdp::ByteBuffer blueprint = R"(
# My API
## GET /message
+ Response 200 (text/plain)

        Hello World!
)";

snowcrash::ParseResult<snowcrash::Blueprint> ast;
snowcrash::parse(blueprint, 0, ast);

std::cout << "API Name: " << ast.node.name << std::endl;

Refer to Blueprint.h for the details about the Snow Crash AST and BlueprintSourcemap.h for details about Source Maps tree.

Command line tool

CLI was removed. It is replaced by utility named drafter

Build

  1. Clone the repo + fetch the submodules:

    $ git clone --recursive git://github.com/apiaryio/snowcrash.git
    $ cd snowcrash
  2. Build & test Snow Crash:

    $ ./configure
    $ make test

We love Windows too! Please refer to Building on Windows.

Contribute

Fork & Pull Request

License

MIT License. See the LICENSE file.