{"id":16106493,"url":"https://github.com/vitormattos/blueprint-sdk-maker","last_synced_at":"2025-03-18T08:32:15.515Z","repository":{"id":57078428,"uuid":"91886524","full_name":"vitormattos/blueprint-sdk-maker","owner":"vitormattos","description":"Create SDK client from API Blueprint","archived":false,"fork":false,"pushed_at":"2020-10-13T22:34:34.000Z","size":73,"stargazers_count":14,"open_issues_count":2,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-10T19:13:40.774Z","etag":null,"topics":["api-blueprint","apib","blueprint-sdk-maker","parsing","phar","sdk"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/vitormattos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-05-20T12:05:47.000Z","updated_at":"2024-05-31T16:17:10.000Z","dependencies_parsed_at":"2022-08-24T11:50:06.398Z","dependency_job_id":null,"html_url":"https://github.com/vitormattos/blueprint-sdk-maker","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitormattos%2Fblueprint-sdk-maker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitormattos%2Fblueprint-sdk-maker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitormattos%2Fblueprint-sdk-maker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitormattos%2Fblueprint-sdk-maker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vitormattos","download_url":"https://codeload.github.com/vitormattos/blueprint-sdk-maker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221709071,"owners_count":16867655,"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":["api-blueprint","apib","blueprint-sdk-maker","parsing","phar","sdk"],"created_at":"2024-10-09T19:13:39.827Z","updated_at":"2024-10-27T17:10:28.280Z","avatar_url":"https://github.com/vitormattos.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/vitormattos/blueprint-sdk-maker.svg?branch=master)](https://travis-ci.org/vitormattos/blueprint-sdk-maker)\n[![Coverage Status](https://coveralls.io/repos/github/vitormattos/blueprint-sdk-maker/badge.svg?branch=master)](https://coveralls.io/github/vitormattos/blueprint-sdk-maker?branch=master)\n[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-brightgreen.svg?style=flat)](https://github.com/phpstan/phpstan)\n[![Latest Stable Version](https://poser.pugx.org/vitormattos/blueprint-sdk-maker/v/stable)](https://packagist.org/packages/vitormattos/blueprint-sdk-maker)\n[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.2-blue.svg)](https://php.net/)\n[![License](https://poser.pugx.org/vitormattos/blueprint-sdk-maker/license)](https://packagist.org/packages/vitormattos/blueprint-sdk-maker)\n\n# API Blueprint Parser\n\n\u003e [API Blueprint](https://apiblueprint.org/) is a powerful high-level API description language for web APIs. \n\nThrough that's project it's possible parse `.apib` files, get all their properties and generate all files needed to push a new SDK.\n## How do I get started?\n\n**NOTE:** \n*Blueprint SDK Maker depends on the [Drafter](https://github.com/apiaryio/drafter) library.\nPlease see that repo for build instructions.*\n\nTo generate standalone phar file, set the following in your php.ini:\n\n```\n; http://php.net/phar.readonly\nphar.readonly = Off\n```\n\nIf you don't need generate `phar`, run Blueprint SDK Maker using the option `--no-phar`.\n\n### As a phar (Recommended)\n\nDownload the latest `phar` **[here](https://github.com/vitormattos/blueprint-sdk-maker/releases/latest)**.\n\nYou should put it anywhere that facilitates its accessibility (such /usr/local/bin) and chmod should be 755.\nYou can even rename it to just the box to avoid having to type the `.phar` extension every time.\n\n## Parsing `.apib` files\nRun the follow command replacing `\u003cfilename.apib\u003e` by your `.apib` file.\nThe default output of this command is a directory called `build` containing the source of your SDK and a phar (`api.phar`) to use your SDK standalone.\n\n```\nblueprint-sdk-maker make \u003cfilename.apib\u003e\n```\n\n## Example of using generated SDK\n\n### From phar file\nCreate file called `test.php` into same directory of `api.phar` and run `test.php`\n```php\n\u003c?php\nuse BlueprintSdk\\Core\\Api;\n\nrequire 'api.phar';\n$api = new Api();\n$return = $api-\u003eEntity-\u003egetYourEndpoint('ARGUMENT-X');\nvar_dump($return);\n```\n### From composer file\nAdd the content of the follow `composer.json` file into `composer.json` file of your project replacing `\u003cYourGithubAccout\u003e` and `\u003cTheProjectName\u003e` for your data and run `composer install`.\n```json\n{\n    \"require\" : {\n        \"\u003cYourGithubAccout\u003e/\u003cTheProjectName\u003e\" : \"dev-master\"\n    },\n    \"repositories\" : [{\n            \"type\" : \"vcs\",\n            \"url\" : \"https://github.com/\u003cYourGithubAccout\u003e/\u003cTheProjectName\u003e\"\n        }\n    ]\n}\n```\n\n## Contributing\n\nIf you are interested in fixing issues and contributing directly to the code\nbase, please see the document [How to Contribute](CONTRIBUTING.md), \n\n## License\n\nLicensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitormattos%2Fblueprint-sdk-maker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvitormattos%2Fblueprint-sdk-maker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitormattos%2Fblueprint-sdk-maker/lists"}