Rewrite APIを使用してRESTful URLを構築する


19

RESTful APIの書き換えルールを生成しようとしています。考えられるすべての書き換えの組み合わせを書き出すよりも、この作業を行うためのより良い方法があるかどうかを見たいだけです。

わかりましたので、URLで考慮する4つのクエリ変数があります

  • インジケータ
  • 応答
  • 調査

ベースURLはwww.example.com/some-page/になります。4つの変数の順序は一貫していますが、一部のクエリ変数はオプションです。

だから...

/indicator/{indicator value}/country/{country value}/response/{response value}/survey/{survey value}/

または...(/ response /なし)

/indicator/{indicator value}/country/{country value}/survey/{survey value}/

または...

/indicator/{indicator value}/country/{country value}/

これを達成rewrite_rules_arrayするために、手動で作成された書き換えルールの配列をフィルタリングして追加するよりも良い方法はありますか?add_rewrite_endpoint()rewrite_endpointまたはadd_rewrite_tag()私にとって何か役に立つでしょうか?

回答:


18

最良の選択肢はエンドポイントだと思います。すべてのデータを単純な文字列として取得するため、どのように解析するかを決定でき、他の書き換えルールとの衝突を心配する必要はありません。

エンドポイントについて私が学んだことの1つは、主な作業を可能な限り抽象化し、WordPress APIの不具合をデータに依存しない方法で修正することです。

ロジックを3つの部分に分けます。コントローラーはモデルとビューを選択し、エンドポイントを処理するモデルといくつかの有用なデータまたはエラーメッセージを返す1つ以上のビューを選択します。

コントローラー

コントローラーから始めましょう。それはあまり役に立たないので、ここでは非常に簡単な関数を使用します。

add_action( 'plugins_loaded', 't5_cra_init' );

function t5_cra_init()
{
    require dirname( __FILE__ ) . '/class.T5_CRA_Model.php';

    $options = array (
        'callback' => array ( 'T5_CRA_View_Demo', '__construct' ),
        'name'     => 'api',
        'position' => EP_ROOT
    );
    new T5_CRA_Model( $options );
}

基本的に、それはモデルT5_CRA_Modelをロードし、いくつかのパラメータを渡します...そしてすべての作業。コントローラーは、モデルまたはビューの内部ロジックについて何も知りません。両方が結合するだけです。これは再利用できない唯一の部分です。だから、私はそれを他の部分から分離したままにしました。


ここで、少なくとも2つのクラスが必要です。APIを登録するモデルと、出力を作成するビューです。

モデル

このクラスは:

  • エンドポイントを登録する
  • 追加パラメーターなしでエンドポイントが呼び出された場合をキャッチ
  • サードパーティのコードのいくつかのバグのために欠落している書き換えルールを埋めます
  • 静的なフロントページとエンドポイントでWordPressの不具合を修正 EP_ROOT
  • URIを配列に解析します(これも分離できます)
  • それらの値でコールバックハンドラを呼び出します

コードがそれ自体を物語っていることを願っています。:)

モデルは、データの内部構造やプレゼンテーションについて何も知りません。したがって、1行を変更せずに何百ものAPIを登録するために使用できます。

<?php  # -*- coding: utf-8 -*-
/**
 * Register new REST API as endpoint.
 *
 * @author toscho http://toscho.de
 *
 */
class T5_CRA_Model
{
    protected $options;

    /**
     * Read options and register endpoint actions and filters.
     *
     * @wp-hook plugins_loaded
     * @param   array $options
     */
    public function __construct( Array $options )
    {
        $default_options = array (
            'callback' => array ( 'T5_CRA_View_Demo', '__construct' ),
            'name'     => 'api',
            'position' => EP_ROOT
        );

        $this->options = wp_parse_args( $options, $default_options );

        add_action( 'init', array ( $this, 'register_api' ), 1000 );

        // endpoints work on the front end only
        if ( is_admin() )
            return;

        add_filter( 'request', array ( $this, 'set_query_var' ) );
        // Hook in late to allow other plugins to operate earlier.
        add_action( 'template_redirect', array ( $this, 'render' ), 100 );
    }

    /**
     * Add endpoint and deal with other code flushing our rules away.
     *
     * @wp-hook init
     * @return void
     */
    public function register_api()
    {
        add_rewrite_endpoint(
            $this->options['name'],
            $this->options['position']
        );
        $this->fix_failed_registration(
            $this->options['name'],
            $this->options['position']
        );
    }

    /**
     * Fix rules flushed by other peoples code.
     *
     * @wp-hook init
     * @param string $name
     * @param int    $position
     */
    protected function fix_failed_registration( $name, $position )
    {
        global $wp_rewrite;

        if ( empty ( $wp_rewrite->endpoints ) )
            return flush_rewrite_rules( FALSE );

        foreach ( $wp_rewrite->endpoints as $endpoint )
            if ( $endpoint[0] === $position && $endpoint[1] === $name )
                return;

        flush_rewrite_rules( FALSE );
    }

    /**
     * Set the endpoint variable to TRUE.
     *
     * If the endpoint was called without further parameters it does not
     * evaluate to TRUE otherwise.
     *
     * @wp-hook request
     * @param   array $vars
     * @return  array
     */
    public function set_query_var( Array $vars )
    {
        if ( ! empty ( $vars[ $this->options['name'] ] ) )
            return $vars;

        // When a static page was set as front page, the WordPress endpoint API
        // does some strange things. Let's fix that.
        if ( isset ( $vars[ $this->options['name'] ] )
            or ( isset ( $vars['pagename'] ) and $this->options['name'] === $vars['pagename'] )
            or ( isset ( $vars['page'] ) and $this->options['name'] === $vars['name'] )
            )
        {
            // In some cases WP misinterprets the request as a page request and
            // returns a 404.
            $vars['page'] = $vars['pagename'] = $vars['name'] = FALSE;
            $vars[ $this->options['name'] ] = TRUE;
        }
        return $vars;
    }

    /**
     * Prepare API requests and hand them over to the callback.
     *
     * @wp-hook template_redirect
     * @return  void
     */
    public function render()
    {
        $api = get_query_var( $this->options['name'] );
        $api = trim( $api, '/' );

        if ( '' === $api )
            return;

        $parts  = explode( '/', $api );
        $type   = array_shift( $parts );
        $values = $this->get_api_values( join( '/', $parts ) );
        $callback = $this->options['callback'];

        if ( is_string( $callback ) )
        {
            call_user_func( $callback, $type, $values );
        }
        elseif ( is_array( $callback ) )
        {
            if ( '__construct' === $callback[1] )
                new $callback[0]( $type, $values );
            elseif ( is_callable( $callback ) )
                call_user_func( $callback, $type, $values );
        }
        else
        {
            trigger_error(
                'Cannot call your callback: ' . var_export( $callback, TRUE ),
                E_USER_ERROR
            );
        }

        // Important. WordPress will render the main page if we leave this out.
        exit;
    }

    /**
     * Parse request URI into associative array.
     *
     * @wp-hook template_redirect
     * @param   string $request
     * @return  array
     */
    protected function get_api_values( $request )
    {
        $keys    = $values = array();
        $count   = 0;
        $request = trim( $request, '/' );
        $tok     = strtok( $request, '/' );

        while ( $tok !== FALSE )
        {
            0 === $count++ % 2 ? $keys[] = $tok : $values[] = $tok;
            $tok = strtok( '/' );
        }

        // fix odd requests
        if ( count( $keys ) !== count( $values ) )
            $values[] = '';

        return array_combine( $keys, $values );
    }
}

景色

次に、データを使用して何かをする必要があります。不完全なリクエストの欠落データをキャッチしたり、他のビューやサブコントローラーに処理を委任することもできます。

これは非常に簡単な例です:

class T5_CRA_View_Demo
{
    protected $allowed_types = array (
            'plain',
            'html',
            'xml'
    );

    protected $default_values = array (
        'country' => 'Norway',
        'date'    => 1700,
        'max'     => 200
    );
    public function __construct( $type, $data )
    {
        if ( ! in_array( $type, $this->allowed_types ) )
            die( 'Your request is invalid. Please read our fantastic manual.' );

        $data = wp_parse_args( $data, $this->default_values );

        header( "Content-Type: text/$type;charset=utf-8" );
        $method = "render_$type";
        $this->$method( $data );
    }

    protected function render_plain( $data )
    {
        foreach ( $data as $key => $value )
            print "$key: $value\n";
    }
    protected function render_html( $data ) {}
    protected function render_xml( $data ) {}
}

重要な部分は、ビューがエンドポイントについて何も知らないことです。これを使用して、完全に異なるリクエスト、たとえばのAJAXリクエストを処理できますwp-admin。ビューを独自のMVCパターンに分割するか、単純な関数を使用できます。


2
掘って 私はこのタイプのパターンが好きです。
kingkool68
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.