vitormattos/blueprint-sdk-maker

从 API Blueprint 创建 SDK 客户端

维护者

详细信息

github.com/vitormattos/blueprint-sdk-maker

主页

源代码

问题

安装: 6

依赖: 0

建议者: 0

安全: 0

星星: 14

关注者: 2

分支: 6

开放问题: 2

0.3 2017-08-21 16:44 UTC

Requires

Requires (Dev)

MIT f6b52352e68b95faa894586f7ac25a6df083c4ac

apiparserblueprintapib

This package is auto-updated.

Last update: 2024-08-29 04:31:22 UTC

README

Build Status Coverage Status PHPStan Latest Stable Version Minimum PHP Version License

API Blueprint 解析器

API Blueprint 是一种强大的高级 API 描述语言，适用于 Web API。

通过该项目，可以解析 .apib 文件，获取所有属性，并生成推送新 SDK 所需的所有文件。

如何开始？

注意： Blueprint SDK Maker 依赖于 Drafter 库。请参阅该存储库的构建说明。

要生成独立的 phar 文件，请在您的 php.ini 中设置以下内容：

; https://php.ac.cn/phar.readonly
phar.readonly = Off

如果您不需要生成 phar，请使用 --no-phar 选项运行 Blueprint SDK Maker。

作为 phar（推荐）

在此处下载最新的 phar here。

您应该将其放置在便于访问的任何位置（例如 /usr/local/bin），并且 chmod 应为 755。您甚至可以将其重命名为纯名称，以避免每次都必须输入 .phar 扩展名。

解析 .apib 文件

运行以下命令，用您的 .apib 文件替换 <filename.apib>。此命令的默认输出是名为 build 的目录，其中包含 SDK 的源代码以及用于独立使用 SDK 的 phar（《api.phar》）。

blueprint-sdk-maker make <filename.apib>

生成 SDK 的示例

从 phar 文件

在 api.phar 的同一目录中创建名为 test.php 的文件，并运行 test.php

<?php
use BlueprintSdk\Core\Api;

require 'api.phar';
$api = new Api();
$return = $api->Entity->getYourEndpoint('ARGUMENT-X');
var_dump($return);

从 composer 文件

将以下 composer.json 文件的内容添加到您的项目的 composer.json 文件中，用您的数据替换 <YourGithubAccout> 和 <TheProjectName>，然后运行 composer install。

{
    "require" : {
        "<YourGithubAccout>/<TheProjectName>" : "dev-master"
    },
    "repositories" : [{
            "type" : "vcs",
            "url" : "https://github.com/<YourGithubAccout>/<TheProjectName>"
        }
    ]
}

贡献

如果您对修复问题和直接向代码库贡献感兴趣，请参阅文档 如何贡献。

许可证

在 MIT 许可证下授权。