作曲家を使用してJSONスキーマの検証の問題を解決する方法

次の住所から作曲家を 学ぶことができます。

Symfonyベースのアプリケーションを開発する際に、JSONデータ形式を効果的に検証する方法を開発する際に、トリッキーな問題に遭遇しました。最初は、手動検証コードを使用しようとしましたが、これは複雑であるだけでなく、エラーが発生しやすいものでもありました。いくつかの調査の後、私はptyhard/json-schema-bundleという作曲家パッケージを発見しました。

まず、作曲家を介してこのパッケージをインストールするのは非常に簡単です。

 <code>composer req ptyhard/json-schema-bundle "dev-master"</code>

インストールが完了したら、 config/bundles.phpファイルに次の構成を追加する必要があります。

 <code class="php"><?php return [
    ...
    Ptyhard\JsonSchemaBundle\JsonSchemaBundle::class => ['all' => true] ];</code>

次に、 config/packages/ptyhard_json_schema.ymlファイルにパッケージ構成を紹介します。

 <code class="yaml"># config/packages/ptyhard_json_schema.yml ptyhard_json_schema: use_jms_serializer: true # default true json_file_directory: ~ # default null json_write_directory: # default null</code>

ptyhard/json-schema-bundleを使用したJSONスキーマの検証は非常に直感的です。まず、スキーマPHPクラスを作成する必要があります。

 <code class="php"><?php // src/JsonSchema/User.php

namespace App\JsonSchema;

use Ptyhard\JsonSchemaBundle\Annotations\SchemaClass;
use Ptyhard\JsonSchemaBundle\Annotations\Property;

/**
 * @SchemaClass(required={"id","name"})
 */
class User 
{
    /**
     * @Property\NumberProperty("id")
     *
     * @var int
     */
    private $id;

    /**
     * @Property\StringProperty("name")
     *
     * @var string
     */
    private $name;
}</code></code>

次に、検証のためにコントローラーでこのスキーマクラスを使用します。たとえば

<?php

namespace App\Controller;

use App\JsonSchema\User;
use Polidog\SimpleApiBundle\Annotations\Api;
use Symfony\Component\Routing\Annotation\Route;

/**
 * @Route("/")
 */
class TopController
{
    /**
     * @Route("/request/check",methods={"POST"}) 
     * @Api(statusCode=200)
     *
     * @param User $user
     * @return User
     */
    public function requestCheck(User $user) : User
    {
        return  [];
    }

    /**
     * @Route("/response/check",methods={"GET"}) 
     * @Api(statusCode=200)
     *
     * @return User
     */
    public function responseCheck() : User
    {
        return new User();
    }
}</code>

JSONスキーマファイルを生成する必要がある場合は、次のコマンドを使用できます。

 <code>$ bin/console json-schema:generate:file</code>

ptyhard/json-schema-bundleを使用すると、JSONデータの検証プロセスを簡素化するだけでなく、コードの保守性と読みやすさも向上します。このパッケージを作曲家と簡単に統合して、プロジェクトにJSONスキーマの検証を迅速に実装し、開発効率とデータの精度を大幅に改善することができました。

一般に、Composerは依存関係管理を簡素化するだけでなく、開発者に豊富なサードパーティライブラリとツールを提供し、複雑な問題を解決しやすくします。 JSONスキーマの検証を必要とするSymfonyプロジェクトの場合、 ptyhard/json-schema-bundle間違いなく強力で実用的な選択です。

以上が作曲家を使用してJSONスキーマの検証の問題を解決する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。