avtocod/specs-php

PHP SDK for 'Avtocod project' specifications

v1.8.0 2024-01-24 12:13 UTC

Requires

• php: ^8.0.2
• ext-json: *
• ext-mbstring: *
• avtocod/specs: ~3.70
• illuminate/support: ~9.0 || ~10.0

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9.6 || ^10.0

MIT

• Avtocod

• sdk
• specs
• Specifications
• avtocod

README

PHP SDK for avtocod/specs

This repository contains SDK for data from avtocod/specs specifications repository.

Install

Require this package with composer using the following command:

$ composer require avtocod/specs-php "^1.0"

Installed composer is required (how to install composer).

You need to fix the major version of package.

Usage

use Avtocod\Specifications\Specifications;

// Get specifications (not SDK) version
$version = Specifications::version();

// Get report content (full example)
$report_example = Specifications::getReportExample();

// Get report json-schema (as an object or associative array)
$report_schema = Specifications::getReportJsonSchema();

For more examples - look into sources.

Testing

For package testing we use phpunit framework and docker-ce + docker-compose as develop environment. So, just write into your terminal after repository cloning:

$ make build
$ make latest # or 'make lowest'
$ make test

Changes log

Changes log can be found here.

Support

If you will find any package errors, please, make an issue in current repository.

License

This is open-sourced software licensed under the MIT License.