{"id":13548433,"url":"https://github.com/apiaryio/snowcrash","last_synced_at":"2025-04-02T21:31:28.984Z","repository":{"id":7802922,"uuid":"9173280","full_name":"apiaryio/snowcrash","owner":"apiaryio","description":"API Blueprint Parser","archived":true,"fork":false,"pushed_at":"2018-07-18T08:52:40.000Z","size":2428,"stargazers_count":374,"open_issues_count":0,"forks_count":56,"subscribers_count":27,"default_branch":"master","last_synced_at":"2024-11-03T17:39:34.566Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apiaryio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-04-02T15:23:04.000Z","updated_at":"2024-02-27T07:36:23.000Z","dependencies_parsed_at":"2022-08-30T17:01:05.400Z","dependency_job_id":null,"html_url":"https://github.com/apiaryio/snowcrash","commit_stats":null,"previous_names":[],"tags_count":49,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fsnowcrash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fsnowcrash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fsnowcrash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apiaryio%2Fsnowcrash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apiaryio","download_url":"https://codeload.github.com/apiaryio/snowcrash/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246895758,"owners_count":20851323,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T12:01:10.284Z","updated_at":"2025-04-02T21:31:28.103Z","avatar_url":"https://github.com/apiaryio.png","language":"C++","funding_links":[],"categories":["C++","others","API Design Tooling"],"sub_categories":["API-Blueprint"],"readme":"![logo](https://raw.github.com/apiaryio/api-blueprint/master/assets/logo_apiblueprint.png)\n\n# Snow Crash [![Build Status](https://travis-ci.org/apiaryio/snowcrash.svg?branch=master)](https://travis-ci.org/apiaryio/snowcrash) [![Build status](https://ci.appveyor.com/api/projects/status/gupp1f7ymifxh3yn/branch/master?svg=true)](https://ci.appveyor.com/project/Apiary/snowcrash)\n\n\n### API Blueprint Parser\nSnow Crash is the reference [API Blueprint](http://apiblueprint.org) parser built on top of the [Sundown](https://github.com/vmg/sundown) Markdown parser.\n\nAPI Blueprint is Web API documentation language. You can find API Blueprint documentation on the [API Blueprint site](http://apiblueprint.org).\n\n## Status\n- [Format 1A8](https://github.com/apiaryio/api-blueprint/releases/tag/format-1A8) fully implemented\n\n## Use\n\n### C++ library\n\n```c++\n#include \"snowcrash.h\"\n\nmdp::ByteBuffer blueprint = R\"(\n# My API\n## GET /message\n+ Response 200 (text/plain)\n\n        Hello World!\n)\";\n\nsnowcrash::ParseResult\u003csnowcrash::Blueprint\u003e ast;\nsnowcrash::parse(blueprint, 0, ast);\n\nstd::cout \u003c\u003c \"API Name: \" \u003c\u003c ast.node.name \u003c\u003c std::endl;\n```\n\nRefer to [`Blueprint.h`](src/Blueprint.h) for the details about the Snow Crash AST and [`BlueprintSourcemap.h`](src/BlueprintSourcemap.h) for details about Source Maps tree.\n\n### Command line tool\n\nCLI was removed. It is replaced by utility named [drafter](https://github.com/apiaryio/drafter)\n\n## Build\n1. Clone the repo + fetch the submodules:\n\n\t```sh\n\t$ git clone --recursive git://github.com/apiaryio/snowcrash.git\n\t$ cd snowcrash\n\t```\n\n2. Build \u0026 test Snow Crash:\n\n\t```sh\n\t$ ./configure\n\t$ make test\n\t```\n\nWe love **Windows** too! Please refer to [Building on Windows](https://github.com/apiaryio/snowcrash/wiki/Building-on-Windows).\n\n\n## Contribute\nFork \u0026 Pull Request\n\n## License\nMIT License. See the [LICENSE](https://github.com/apiaryio/snowcrash/blob/master/LICENSE) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapiaryio%2Fsnowcrash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapiaryio%2Fsnowcrash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapiaryio%2Fsnowcrash/lists"}