Custom route endpoint for WP-REST API gives "code": "rest_no_route", error

Divyanshu Jimmy picture Divyanshu Jimmy · Apr 15, 2016 · Viewed 11.2k times · Source

I am following this tutorial to create custom end points to WP-API .

I am always getting this error on hitting /wp-json/custom-plugin/v2/get-all-post-ids/ on postman to test :

{
    "code": "rest_no_route",
    "message": "No route was found matching
    the URL and request method ", 
    "data": {
        "status": 404
    }
}

I have created a custom-plugin.php file in /plugins/custom-plugin/ directory .

<?php
    if ( ! defined( 'ABSPATH' ) ) exit;

    add_action( 'rest_api_init', 'dt_register_api_hooks' );

    function dt_register_api_hooks() {    

        register_rest_route( 'custom-plugin/v2', '/get-all-post-ids/', array(
            'methods' => 'GET',
            'callback' => 'dt_get_all_post_ids',
            ) 
            );
    }
    // Return all post IDs
    function dt_get_all_post_ids() {
        if ( false === ( $all_post_ids = get_transient( 'dt_all_post_ids' ) ) ) {
            $all_post_ids = get_posts( array(
                'numberposts' => -1,
                'post_type'   => 'post',
                'fields'      => 'ids',
            ) );
            // cache for 2 hours
            set_transient( 'dt_all_post_ids', $all_post_ids, 60*60*2 );
        }
        return $all_post_ids;
    }
?>

Answer

Tyler Collier picture Tyler Collier · Feb 25, 2021

Ensure your callback to add_action( 'rest_api_init', 'dt_register_api_hooks' ); is being run.

In my case, my callback was not being called because I was using add_action('rest_api_init', ...) too late; the action had already fired. As in, my call to register_rest_route() never even happened.