https://github.com/vitormattos/blueprint-sdk-maker

Create SDK client from API Blueprint
https://github.com/vitormattos/blueprint-sdk-maker

api-blueprint apib blueprint-sdk-maker parsing phar sdk

Last synced: 9 days ago
JSON representation

Create SDK client from API Blueprint

• Host: GitHub
• URL: https://github.com/vitormattos/blueprint-sdk-maker
• Owner: vitormattos
• License: mit
• Created: 2017-05-20T12:05:47.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-10-13T22:34:34.000Z (about 4 years ago)
• Last Synced: 2024-10-10T19:13:40.774Z (26 days ago)
• Topics: api-blueprint, apib, blueprint-sdk-maker, parsing, phar, sdk
• Language: PHP
• Homepage:
• Size: 71.3 KB
• Stars: 14
• Watchers: 2
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/vitormattos/blueprint-sdk-maker.svg?branch=master)](https://travis-ci.org/vitormattos/blueprint-sdk-maker)

[![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)

[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-brightgreen.svg?style=flat)](https://github.com/phpstan/phpstan)

[![Latest Stable Version](https://poser.pugx.org/vitormattos/blueprint-sdk-maker/v/stable)](https://packagist.org/packages/vitormattos/blueprint-sdk-maker)

[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.2-blue.svg)](https://php.net/)

[![License](https://poser.pugx.org/vitormattos/blueprint-sdk-maker/license)](https://packagist.org/packages/vitormattos/blueprint-sdk-maker)

# API Blueprint Parser

> [API Blueprint](https://apiblueprint.org/) is a powerful high-level API description language for web APIs. 

Through that's project it's possible parse `.apib` files, get all their properties and generate all files needed to push a new SDK.

## How do I get started?

**NOTE:** 

*Blueprint SDK Maker depends on the [Drafter](https://github.com/apiaryio/drafter) library.

Please see that repo for build instructions.*

To generate standalone phar file, set the following in your php.ini:

```

; http://php.net/phar.readonly

phar.readonly = Off

```

If you don't need generate `phar`, run Blueprint SDK Maker using the option `--no-phar`.

### As a phar (Recommended)

Download the latest `phar` **[here](https://github.com/vitormattos/blueprint-sdk-maker/releases/latest)**.

You should put it anywhere that facilitates its accessibility (such /usr/local/bin) and chmod should be 755.

You can even rename it to just the box to avoid having to type the `.phar` extension every time.

## Parsing `.apib` files

Run the follow command replacing `` by your `.apib` file.

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

```

blueprint-sdk-maker make 

```

## Example of using generated SDK

### From phar file

Create file called `test.php` into same directory of `api.phar` and run `test.php`

```php

Entity->getYourEndpoint('ARGUMENT-X');

var_dump($return);

```

### From composer file

Add the content of the follow `composer.json` file into `composer.json` file of your project replacing `` and `` for your data and run `composer install`.

```json

{

    "require" : {

        "/" : "dev-master"

    },

    "repositories" : [{

            "type" : "vcs",

            "url" : "https://github.com//"

        }

    ]

}

```

## Contributing

If you are interested in fixing issues and contributing directly to the code

base, please see the document [How to Contribute](CONTRIBUTING.md), 

## License

Licensed under the MIT License.