README

关于 Swapi

"Swapi 包" 是一个简单的包装包，提供了以下 API 访问的人员列表和相关星球信息：

GET /api/people (提供分页的人员列表，可筛选和排序)
GET /api/people/{peopleId} (提供选定的人员数据，包括星球详细信息)

技术

Laravel 8.*

依赖关系

guzzlehttp/guzzle
phpunit/phpunit
inertiajs/inertia-laravel

安装和配置 Swapi 包

要安装 Swapi 包，请运行以下命令

composer require christiancocco/swapi --with-all-dependencies

现在您可以配置测试环境文件，以便能够运行测试脚本。

创建测试数据库
在您的根应用程序文件夹中创建 .env.testing 文件，并更改数据库连接参数
将以下内容添加到 phpunit.xml 文件中

<?xml version="1.0" encoding="UTF-8"?>

    <!-- ... -->

    <testsuites>

        <!-- ... -->

        <testsuite name="SwapiUnit">
            <directory suffix="Test.php">./vendor/christiancocco/swapi/tests/Unit</directory>
        </testsuite>
        <testsuite name="SwapiTest">
            <directory suffix="Test.php">./vendor/christiancocco/swapi/tests/Feature</directory>
        </testsuite>
    </testsuites>

使用方法

安装后，您必须运行以下命令

php artisan swapi:install

此命令初始化包（复制配置文件）并运行星球和人员表的迁移。

php artisan swapi:init

此命令初始化从 swapi.dev 获取的数据。

（完整文档：https://swapi.dev/documentation）

注意。要初始化测试数据库，请运行此命令

php artisan migrate --env=testing

如果您想过滤、排序和分页 /api/people 的结果，可以使用以下查询字符串参数

query: 在所有人员字段中搜索的字符串
itemperpage: 每页项目数（默认值 = 10）
page: 页码
sort: 排序字段
sortVer: 排序方向（ASC：升序 - 默认值；DESC：降序）

示例：/api/people?query=fair&sort=name&sortVer=DESC&itemperpage=2&page=2

测试

要运行单元测试，请运行此命令

php artisan test --filter=Swapi --stop-on-failure

要测试 API，请运行

php artisan serve

并访问

https://:8000/swapi-test

许可

Swapi Laravel 包是开源软件，受 MIT 许可许可。

christiancocco / swapi

维护者

详细信息

README

目录

关于 Swapi

技术

依赖关系

安装和配置 Swapi 包

使用方法

测试

许可