Why is my custom API endpoint not working? The 2019 Stack Overflow Developer Survey Results Are In2019 Community Moderator ElectionWordpress Api Get DraftsSending post data over REST API, how to parse shortcodes in post_content?How to call wp plugin REST functions without curl?How to use Wordpress rest API with Angularjs 4Update CPT meta data using REST APIcustom REST endpoint not passing body of POST request to callbackCustom Rest API namespace and endpoints are responding with 404 & 503 errorsHow to get custom fields in a post when publishedHow to feed a HTML5's EventSource with a REST API custom endpoint?Callback to custom field is not working in Wordpress REST API

What is the meaning of Triage in Cybersec world?

Did 3000BC Egyptians use meteoric iron weapons?

Delete all lines which don't have n characters before delimiter

Statement true because not provable

Deal with toxic manager when you can't quit

One word riddle: Vowel in the middle

Where to refill my bottle in India?

Why isn't the circumferential light around the M87 black hole's event horizon symmetric?

"as much details as you can remember"

What is the closest word meaning "respect for time / mindful"

Worn-tile Scrabble

For what reasons would an animal species NOT cross a *horizontal* land bridge?

Sci-fi book where a human is taken from Earth to help man an alien ship in a fight against other aliens and rises through the ranks to command

Why is my custom API endpoint not working?

Protecting Dualbooting Windows from dangerous code (like rm -rf)

Why hard-Brexiteers don't insist on a hard border to prevent illegal immigration after Brexit?

Scaling a graph of a circle and the standard parabola in TikZ

What to do when moving next to a bird sanctuary with a loosely-domesticated cat?

How to save as into a customized destination on macOS?

Do these rules for Critical Successes and Critical Failures seem Fair?

Landlord wants to switch my lease to a "Land contract" to "get back at the city"

Am I thawing this London Broil safely?

Building a conditional check constraint

Can someone be penalized for an "unlawful" act if no penalty is specified?



Why is my custom API endpoint not working?



The 2019 Stack Overflow Developer Survey Results Are In
2019 Community Moderator ElectionWordpress Api Get DraftsSending post data over REST API, how to parse shortcodes in post_content?How to call wp plugin REST functions without curl?How to use Wordpress rest API with Angularjs 4Update CPT meta data using REST APIcustom REST endpoint not passing body of POST request to callbackCustom Rest API namespace and endpoints are responding with 404 & 503 errorsHow to get custom fields in a post when publishedHow to feed a HTML5's EventSource with a REST API custom endpoint?Callback to custom field is not working in Wordpress REST API



.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty margin-bottom:0;








3















I tried to include this code in my plug-in php files as well as in functions.php.
(In the end I would like it to be in the plug-in's php file but I'm not yet sure if possible, that would probably be the topic of another question.)



It is a very basic method for now, I'm just trying to get a response with some content.



In both cases, I get a 404 response.



add_action( 'rest_api_init', function () 
register_rest_route( plugin_dir_url(__DIR__).'my-project/api/v1/form', '/action', array(
'methods' => 'GET, POST',
'callback' => 'api_method',
) );
);

function api_method($data)
var_dump($data);
return 'API method end.';



And I tried to access URLs (in brower or with AJAX)



  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form

  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form/

  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form/get

  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form/get/

I guess I'm missing something.










share|improve this question







New contributor




TTT is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.




















  • Rest API endpoints live at /wp-json, to include plugin_dir_url in your endpoint registration is extremely unusual, I would strongly recommend against REST endpoint URLs in the plugins folder ( mostly because that's not how the API works, you can't have those kinds of URLs )

    – Tom J Nowell
    7 hours ago











  • @TomJNowell – Can you see why this question got so many views in such a short time? Should I ask this on Meta?

    – leymannx
    1 hour ago

















3















I tried to include this code in my plug-in php files as well as in functions.php.
(In the end I would like it to be in the plug-in's php file but I'm not yet sure if possible, that would probably be the topic of another question.)



It is a very basic method for now, I'm just trying to get a response with some content.



In both cases, I get a 404 response.



add_action( 'rest_api_init', function () 
register_rest_route( plugin_dir_url(__DIR__).'my-project/api/v1/form', '/action', array(
'methods' => 'GET, POST',
'callback' => 'api_method',
) );
);

function api_method($data)
var_dump($data);
return 'API method end.';



And I tried to access URLs (in brower or with AJAX)



  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form

  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form/

  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form/get

  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form/get/

I guess I'm missing something.










share|improve this question







New contributor




TTT is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.




















  • Rest API endpoints live at /wp-json, to include plugin_dir_url in your endpoint registration is extremely unusual, I would strongly recommend against REST endpoint URLs in the plugins folder ( mostly because that's not how the API works, you can't have those kinds of URLs )

    – Tom J Nowell
    7 hours ago











  • @TomJNowell – Can you see why this question got so many views in such a short time? Should I ask this on Meta?

    – leymannx
    1 hour ago













3












3








3








I tried to include this code in my plug-in php files as well as in functions.php.
(In the end I would like it to be in the plug-in's php file but I'm not yet sure if possible, that would probably be the topic of another question.)



It is a very basic method for now, I'm just trying to get a response with some content.



In both cases, I get a 404 response.



add_action( 'rest_api_init', function () 
register_rest_route( plugin_dir_url(__DIR__).'my-project/api/v1/form', '/action', array(
'methods' => 'GET, POST',
'callback' => 'api_method',
) );
);

function api_method($data)
var_dump($data);
return 'API method end.';



And I tried to access URLs (in brower or with AJAX)



  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form

  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form/

  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form/get

  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form/get/

I guess I'm missing something.










share|improve this question







New contributor




TTT is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.












I tried to include this code in my plug-in php files as well as in functions.php.
(In the end I would like it to be in the plug-in's php file but I'm not yet sure if possible, that would probably be the topic of another question.)



It is a very basic method for now, I'm just trying to get a response with some content.



In both cases, I get a 404 response.



add_action( 'rest_api_init', function () 
register_rest_route( plugin_dir_url(__DIR__).'my-project/api/v1/form', '/action', array(
'methods' => 'GET, POST',
'callback' => 'api_method',
) );
);

function api_method($data)
var_dump($data);
return 'API method end.';



And I tried to access URLs (in brower or with AJAX)



  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form

  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form/

  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form/get

  • http://my-domain.local/wp-content/plugins/my-project/api/v1/form/get/

I guess I'm missing something.







rest-api endpoints






share|improve this question







New contributor




TTT is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.











share|improve this question







New contributor




TTT is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.









share|improve this question




share|improve this question






New contributor




TTT is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.









asked 8 hours ago









TTTTTT

1628




1628




New contributor




TTT is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.





New contributor





TTT is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.






TTT is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.












  • Rest API endpoints live at /wp-json, to include plugin_dir_url in your endpoint registration is extremely unusual, I would strongly recommend against REST endpoint URLs in the plugins folder ( mostly because that's not how the API works, you can't have those kinds of URLs )

    – Tom J Nowell
    7 hours ago











  • @TomJNowell – Can you see why this question got so many views in such a short time? Should I ask this on Meta?

    – leymannx
    1 hour ago

















  • Rest API endpoints live at /wp-json, to include plugin_dir_url in your endpoint registration is extremely unusual, I would strongly recommend against REST endpoint URLs in the plugins folder ( mostly because that's not how the API works, you can't have those kinds of URLs )

    – Tom J Nowell
    7 hours ago











  • @TomJNowell – Can you see why this question got so many views in such a short time? Should I ask this on Meta?

    – leymannx
    1 hour ago
















Rest API endpoints live at /wp-json, to include plugin_dir_url in your endpoint registration is extremely unusual, I would strongly recommend against REST endpoint URLs in the plugins folder ( mostly because that's not how the API works, you can't have those kinds of URLs )

– Tom J Nowell
7 hours ago





Rest API endpoints live at /wp-json, to include plugin_dir_url in your endpoint registration is extremely unusual, I would strongly recommend against REST endpoint URLs in the plugins folder ( mostly because that's not how the API works, you can't have those kinds of URLs )

– Tom J Nowell
7 hours ago













@TomJNowell – Can you see why this question got so many views in such a short time? Should I ask this on Meta?

– leymannx
1 hour ago





@TomJNowell – Can you see why this question got so many views in such a short time? Should I ask this on Meta?

– leymannx
1 hour ago










2 Answers
2






active

oldest

votes


















2














Maybe start with just GET. Your route looks weird as well. Try just:



register_rest_route('my-project/v1', '/action/', [
'methods' => WP_REST_Server::READABLE,
'callback' => 'api_method',
]);



And your callback is not returning a valid response. Let your callback look more like this:



$data = [ 'foo' => 'bar' ];

$response = new WP_REST_Response($data, 200);

// Set headers.
$response->set_headers([ 'Cache-Control' => 'must-revalidate, no-cache, no-store, private' ]);

return $response;



Finally you must combine wp-json, the namespace my-project/v1 and your route action to the URL you now can check for what you get:




https://my-domain.local/wp-json/my-project/v1/action





share|improve this answer

























  • I just followed what you suggested, tried my-domain.local/my-project/v1 , my-domain.local/my-project/v1/get (with and without trailing slashes), still getting 404 response. At the moment, the code is in functions.php.

    – TTT
    7 hours ago











  • @TTT – It must be my-domain.local/wp-json/my-project/v1/action as you've specified /action/ to be your route.

    – leymannx
    7 hours ago






  • 1





    Thank you, this worked. Well since the answer is in the comment, I not sure if I should check the answer as solution right away. Also, I can make this return something else than JSON, right ? (I mean not like XML, like php processed HTML code.) ... Then the URL would still contain "wp-json". Weird ... or is there another type of API?

    – TTT
    7 hours ago






  • 2





    @TTT you can store HTML in JSON as a string then JSON decode in the browser

    – Tom J Nowell
    7 hours ago






  • 1





    I just found and tested this way here that looks cleaned than including HTML in JSON: gist.github.com/petenelson/6dc1a405a6e7627b4834

    – TTT
    6 hours ago


















3














Here's your problem:



register_rest_route( plugin_dir_url(__DIR__).'my-project/api/v1/form', '/action', array(


Specifically the idea that this is possible:



http://my-domain.local/wp-content/plugins/my-project/api/v1/form


This is extremely unusual, and runs counter to what's in the docs, handbook, and tutorials.



REST API endpoints live at the REST API, which lives at the URL returned by rest_url(). They live at yoursite.com/wp-json. An endpoint is not a full URL path, or an independent API disconnected from the main API.



Instead, you need to define your endpoint names in terms of namespaces and endpoints, and visit the correct URL as described in the REST API's discovery mechanisms.



If we use this:



register_rest_route( plugin_dir_url(__DIR__).'my-project/api/v1/form', '/action', array(


Then we would expect this:



example.com/wp-json/wp-content/plugins/my-project/api/v1/form/action



That URL is quite long, and has a number of problems:



  • The first parameter is a namespace, not a URL

  • it's not possible to correctly separate out v1 of the API from v2 due to the way that that /form component has been put in the first parameter, not the second. The first parameter is a namespace, the second a route


  • /action is /action, it doesn't get swapped out for GET OR POST

There are also problems with the callback function:



function api_method($data) {
var_dump($data);


An endpoint needs to return its data, it cannot output it directly as var_dump would, otherwise the returned data is invalid JSON.



Finally, the methods parameter is incorrect:



'methods' => 'GET, POST',


methods doesn't take a comma separated list, no docs suggest doing this either. Instead, use the predefined values provided by the REST API such as WP_REST_Server::READABLE or WP_REST_Server::ALLMETHODS, these are all mentioned in the handbook and the official documentation for register_rest_route.



A better route to register would be:



 register_rest_route( 'my-project/form/v1', '/action', array(


Giving us:



example.com/wp-json/my-project/form/v1/action



Notice how I removed the plugin URL and the redundant /api fragment ( it's obvious it's an API already )






share|improve this answer




















  • 1





    Thank you for detailed explanation. I've already marked an answer that came quicker as solution however.

    – TTT
    7 hours ago











  • You can change your mind about which answer is best, but eitherway think of the site as a wiki, there can be more than 1 good answer

    – Tom J Nowell
    5 hours ago











  • One reason why I don't want to change answer is that I have conretely tested and applied the answer I selected as solution. Your answer brought more details and things I had thought in a wrong way somehow, but I haven't litteraly tested and checked it all. I also think that on most StackExchange sites, first good answers get selected, next one get votes. And though this has me scratching my head a bit, I see no reason to remove the solution rewards from the person who solved it first.

    – TTT
    5 hours ago











Your Answer








StackExchange.ready(function()
var channelOptions =
tags: "".split(" "),
id: "110"
;
initTagRenderer("".split(" "), "".split(" "), channelOptions);

StackExchange.using("externalEditor", function()
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled)
StackExchange.using("snippets", function()
createEditor();
);

else
createEditor();

);

function createEditor()
StackExchange.prepareEditor(
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: false,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: null,
bindNavPrevention: true,
postfix: "",
imageUploader:
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
,
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
);



);






TTT is a new contributor. Be nice, and check out our Code of Conduct.









draft saved

draft discarded


















StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fwordpress.stackexchange.com%2fquestions%2f333999%2fwhy-is-my-custom-api-endpoint-not-working%23new-answer', 'question_page');

);

Post as a guest















Required, but never shown

























2 Answers
2






active

oldest

votes








2 Answers
2






active

oldest

votes









active

oldest

votes






active

oldest

votes









2














Maybe start with just GET. Your route looks weird as well. Try just:



register_rest_route('my-project/v1', '/action/', [
'methods' => WP_REST_Server::READABLE,
'callback' => 'api_method',
]);



And your callback is not returning a valid response. Let your callback look more like this:



$data = [ 'foo' => 'bar' ];

$response = new WP_REST_Response($data, 200);

// Set headers.
$response->set_headers([ 'Cache-Control' => 'must-revalidate, no-cache, no-store, private' ]);

return $response;



Finally you must combine wp-json, the namespace my-project/v1 and your route action to the URL you now can check for what you get:




https://my-domain.local/wp-json/my-project/v1/action





share|improve this answer

























  • I just followed what you suggested, tried my-domain.local/my-project/v1 , my-domain.local/my-project/v1/get (with and without trailing slashes), still getting 404 response. At the moment, the code is in functions.php.

    – TTT
    7 hours ago











  • @TTT – It must be my-domain.local/wp-json/my-project/v1/action as you've specified /action/ to be your route.

    – leymannx
    7 hours ago






  • 1





    Thank you, this worked. Well since the answer is in the comment, I not sure if I should check the answer as solution right away. Also, I can make this return something else than JSON, right ? (I mean not like XML, like php processed HTML code.) ... Then the URL would still contain "wp-json". Weird ... or is there another type of API?

    – TTT
    7 hours ago






  • 2





    @TTT you can store HTML in JSON as a string then JSON decode in the browser

    – Tom J Nowell
    7 hours ago






  • 1





    I just found and tested this way here that looks cleaned than including HTML in JSON: gist.github.com/petenelson/6dc1a405a6e7627b4834

    – TTT
    6 hours ago















2














Maybe start with just GET. Your route looks weird as well. Try just:



register_rest_route('my-project/v1', '/action/', [
'methods' => WP_REST_Server::READABLE,
'callback' => 'api_method',
]);



And your callback is not returning a valid response. Let your callback look more like this:



$data = [ 'foo' => 'bar' ];

$response = new WP_REST_Response($data, 200);

// Set headers.
$response->set_headers([ 'Cache-Control' => 'must-revalidate, no-cache, no-store, private' ]);

return $response;



Finally you must combine wp-json, the namespace my-project/v1 and your route action to the URL you now can check for what you get:




https://my-domain.local/wp-json/my-project/v1/action





share|improve this answer

























  • I just followed what you suggested, tried my-domain.local/my-project/v1 , my-domain.local/my-project/v1/get (with and without trailing slashes), still getting 404 response. At the moment, the code is in functions.php.

    – TTT
    7 hours ago











  • @TTT – It must be my-domain.local/wp-json/my-project/v1/action as you've specified /action/ to be your route.

    – leymannx
    7 hours ago






  • 1





    Thank you, this worked. Well since the answer is in the comment, I not sure if I should check the answer as solution right away. Also, I can make this return something else than JSON, right ? (I mean not like XML, like php processed HTML code.) ... Then the URL would still contain "wp-json". Weird ... or is there another type of API?

    – TTT
    7 hours ago






  • 2





    @TTT you can store HTML in JSON as a string then JSON decode in the browser

    – Tom J Nowell
    7 hours ago






  • 1





    I just found and tested this way here that looks cleaned than including HTML in JSON: gist.github.com/petenelson/6dc1a405a6e7627b4834

    – TTT
    6 hours ago













2












2








2







Maybe start with just GET. Your route looks weird as well. Try just:



register_rest_route('my-project/v1', '/action/', [
'methods' => WP_REST_Server::READABLE,
'callback' => 'api_method',
]);



And your callback is not returning a valid response. Let your callback look more like this:



$data = [ 'foo' => 'bar' ];

$response = new WP_REST_Response($data, 200);

// Set headers.
$response->set_headers([ 'Cache-Control' => 'must-revalidate, no-cache, no-store, private' ]);

return $response;



Finally you must combine wp-json, the namespace my-project/v1 and your route action to the URL you now can check for what you get:




https://my-domain.local/wp-json/my-project/v1/action





share|improve this answer















Maybe start with just GET. Your route looks weird as well. Try just:



register_rest_route('my-project/v1', '/action/', [
'methods' => WP_REST_Server::READABLE,
'callback' => 'api_method',
]);



And your callback is not returning a valid response. Let your callback look more like this:



$data = [ 'foo' => 'bar' ];

$response = new WP_REST_Response($data, 200);

// Set headers.
$response->set_headers([ 'Cache-Control' => 'must-revalidate, no-cache, no-store, private' ]);

return $response;



Finally you must combine wp-json, the namespace my-project/v1 and your route action to the URL you now can check for what you get:




https://my-domain.local/wp-json/my-project/v1/action






share|improve this answer














share|improve this answer



share|improve this answer








edited 5 hours ago

























answered 8 hours ago









leymannxleymannx

84211122




84211122












  • I just followed what you suggested, tried my-domain.local/my-project/v1 , my-domain.local/my-project/v1/get (with and without trailing slashes), still getting 404 response. At the moment, the code is in functions.php.

    – TTT
    7 hours ago











  • @TTT – It must be my-domain.local/wp-json/my-project/v1/action as you've specified /action/ to be your route.

    – leymannx
    7 hours ago






  • 1





    Thank you, this worked. Well since the answer is in the comment, I not sure if I should check the answer as solution right away. Also, I can make this return something else than JSON, right ? (I mean not like XML, like php processed HTML code.) ... Then the URL would still contain "wp-json". Weird ... or is there another type of API?

    – TTT
    7 hours ago






  • 2





    @TTT you can store HTML in JSON as a string then JSON decode in the browser

    – Tom J Nowell
    7 hours ago






  • 1





    I just found and tested this way here that looks cleaned than including HTML in JSON: gist.github.com/petenelson/6dc1a405a6e7627b4834

    – TTT
    6 hours ago

















  • I just followed what you suggested, tried my-domain.local/my-project/v1 , my-domain.local/my-project/v1/get (with and without trailing slashes), still getting 404 response. At the moment, the code is in functions.php.

    – TTT
    7 hours ago











  • @TTT – It must be my-domain.local/wp-json/my-project/v1/action as you've specified /action/ to be your route.

    – leymannx
    7 hours ago






  • 1





    Thank you, this worked. Well since the answer is in the comment, I not sure if I should check the answer as solution right away. Also, I can make this return something else than JSON, right ? (I mean not like XML, like php processed HTML code.) ... Then the URL would still contain "wp-json". Weird ... or is there another type of API?

    – TTT
    7 hours ago






  • 2





    @TTT you can store HTML in JSON as a string then JSON decode in the browser

    – Tom J Nowell
    7 hours ago






  • 1





    I just found and tested this way here that looks cleaned than including HTML in JSON: gist.github.com/petenelson/6dc1a405a6e7627b4834

    – TTT
    6 hours ago
















I just followed what you suggested, tried my-domain.local/my-project/v1 , my-domain.local/my-project/v1/get (with and without trailing slashes), still getting 404 response. At the moment, the code is in functions.php.

– TTT
7 hours ago





I just followed what you suggested, tried my-domain.local/my-project/v1 , my-domain.local/my-project/v1/get (with and without trailing slashes), still getting 404 response. At the moment, the code is in functions.php.

– TTT
7 hours ago













@TTT – It must be my-domain.local/wp-json/my-project/v1/action as you've specified /action/ to be your route.

– leymannx
7 hours ago





@TTT – It must be my-domain.local/wp-json/my-project/v1/action as you've specified /action/ to be your route.

– leymannx
7 hours ago




1




1





Thank you, this worked. Well since the answer is in the comment, I not sure if I should check the answer as solution right away. Also, I can make this return something else than JSON, right ? (I mean not like XML, like php processed HTML code.) ... Then the URL would still contain "wp-json". Weird ... or is there another type of API?

– TTT
7 hours ago





Thank you, this worked. Well since the answer is in the comment, I not sure if I should check the answer as solution right away. Also, I can make this return something else than JSON, right ? (I mean not like XML, like php processed HTML code.) ... Then the URL would still contain "wp-json". Weird ... or is there another type of API?

– TTT
7 hours ago




2




2





@TTT you can store HTML in JSON as a string then JSON decode in the browser

– Tom J Nowell
7 hours ago





@TTT you can store HTML in JSON as a string then JSON decode in the browser

– Tom J Nowell
7 hours ago




1




1





I just found and tested this way here that looks cleaned than including HTML in JSON: gist.github.com/petenelson/6dc1a405a6e7627b4834

– TTT
6 hours ago





I just found and tested this way here that looks cleaned than including HTML in JSON: gist.github.com/petenelson/6dc1a405a6e7627b4834

– TTT
6 hours ago













3














Here's your problem:



register_rest_route( plugin_dir_url(__DIR__).'my-project/api/v1/form', '/action', array(


Specifically the idea that this is possible:



http://my-domain.local/wp-content/plugins/my-project/api/v1/form


This is extremely unusual, and runs counter to what's in the docs, handbook, and tutorials.



REST API endpoints live at the REST API, which lives at the URL returned by rest_url(). They live at yoursite.com/wp-json. An endpoint is not a full URL path, or an independent API disconnected from the main API.



Instead, you need to define your endpoint names in terms of namespaces and endpoints, and visit the correct URL as described in the REST API's discovery mechanisms.



If we use this:



register_rest_route( plugin_dir_url(__DIR__).'my-project/api/v1/form', '/action', array(


Then we would expect this:



example.com/wp-json/wp-content/plugins/my-project/api/v1/form/action



That URL is quite long, and has a number of problems:



  • The first parameter is a namespace, not a URL

  • it's not possible to correctly separate out v1 of the API from v2 due to the way that that /form component has been put in the first parameter, not the second. The first parameter is a namespace, the second a route


  • /action is /action, it doesn't get swapped out for GET OR POST

There are also problems with the callback function:



function api_method($data) {
var_dump($data);


An endpoint needs to return its data, it cannot output it directly as var_dump would, otherwise the returned data is invalid JSON.



Finally, the methods parameter is incorrect:



'methods' => 'GET, POST',


methods doesn't take a comma separated list, no docs suggest doing this either. Instead, use the predefined values provided by the REST API such as WP_REST_Server::READABLE or WP_REST_Server::ALLMETHODS, these are all mentioned in the handbook and the official documentation for register_rest_route.



A better route to register would be:



 register_rest_route( 'my-project/form/v1', '/action', array(


Giving us:



example.com/wp-json/my-project/form/v1/action



Notice how I removed the plugin URL and the redundant /api fragment ( it's obvious it's an API already )






share|improve this answer




















  • 1





    Thank you for detailed explanation. I've already marked an answer that came quicker as solution however.

    – TTT
    7 hours ago











  • You can change your mind about which answer is best, but eitherway think of the site as a wiki, there can be more than 1 good answer

    – Tom J Nowell
    5 hours ago











  • One reason why I don't want to change answer is that I have conretely tested and applied the answer I selected as solution. Your answer brought more details and things I had thought in a wrong way somehow, but I haven't litteraly tested and checked it all. I also think that on most StackExchange sites, first good answers get selected, next one get votes. And though this has me scratching my head a bit, I see no reason to remove the solution rewards from the person who solved it first.

    – TTT
    5 hours ago















3














Here's your problem:



register_rest_route( plugin_dir_url(__DIR__).'my-project/api/v1/form', '/action', array(


Specifically the idea that this is possible:



http://my-domain.local/wp-content/plugins/my-project/api/v1/form


This is extremely unusual, and runs counter to what's in the docs, handbook, and tutorials.



REST API endpoints live at the REST API, which lives at the URL returned by rest_url(). They live at yoursite.com/wp-json. An endpoint is not a full URL path, or an independent API disconnected from the main API.



Instead, you need to define your endpoint names in terms of namespaces and endpoints, and visit the correct URL as described in the REST API's discovery mechanisms.



If we use this:



register_rest_route( plugin_dir_url(__DIR__).'my-project/api/v1/form', '/action', array(


Then we would expect this:



example.com/wp-json/wp-content/plugins/my-project/api/v1/form/action



That URL is quite long, and has a number of problems:



  • The first parameter is a namespace, not a URL

  • it's not possible to correctly separate out v1 of the API from v2 due to the way that that /form component has been put in the first parameter, not the second. The first parameter is a namespace, the second a route


  • /action is /action, it doesn't get swapped out for GET OR POST

There are also problems with the callback function:



function api_method($data) {
var_dump($data);


An endpoint needs to return its data, it cannot output it directly as var_dump would, otherwise the returned data is invalid JSON.



Finally, the methods parameter is incorrect:



'methods' => 'GET, POST',


methods doesn't take a comma separated list, no docs suggest doing this either. Instead, use the predefined values provided by the REST API such as WP_REST_Server::READABLE or WP_REST_Server::ALLMETHODS, these are all mentioned in the handbook and the official documentation for register_rest_route.



A better route to register would be:



 register_rest_route( 'my-project/form/v1', '/action', array(


Giving us:



example.com/wp-json/my-project/form/v1/action



Notice how I removed the plugin URL and the redundant /api fragment ( it's obvious it's an API already )






share|improve this answer




















  • 1





    Thank you for detailed explanation. I've already marked an answer that came quicker as solution however.

    – TTT
    7 hours ago











  • You can change your mind about which answer is best, but eitherway think of the site as a wiki, there can be more than 1 good answer

    – Tom J Nowell
    5 hours ago











  • One reason why I don't want to change answer is that I have conretely tested and applied the answer I selected as solution. Your answer brought more details and things I had thought in a wrong way somehow, but I haven't litteraly tested and checked it all. I also think that on most StackExchange sites, first good answers get selected, next one get votes. And though this has me scratching my head a bit, I see no reason to remove the solution rewards from the person who solved it first.

    – TTT
    5 hours ago













3












3








3







Here's your problem:



register_rest_route( plugin_dir_url(__DIR__).'my-project/api/v1/form', '/action', array(


Specifically the idea that this is possible:



http://my-domain.local/wp-content/plugins/my-project/api/v1/form


This is extremely unusual, and runs counter to what's in the docs, handbook, and tutorials.



REST API endpoints live at the REST API, which lives at the URL returned by rest_url(). They live at yoursite.com/wp-json. An endpoint is not a full URL path, or an independent API disconnected from the main API.



Instead, you need to define your endpoint names in terms of namespaces and endpoints, and visit the correct URL as described in the REST API's discovery mechanisms.



If we use this:



register_rest_route( plugin_dir_url(__DIR__).'my-project/api/v1/form', '/action', array(


Then we would expect this:



example.com/wp-json/wp-content/plugins/my-project/api/v1/form/action



That URL is quite long, and has a number of problems:



  • The first parameter is a namespace, not a URL

  • it's not possible to correctly separate out v1 of the API from v2 due to the way that that /form component has been put in the first parameter, not the second. The first parameter is a namespace, the second a route


  • /action is /action, it doesn't get swapped out for GET OR POST

There are also problems with the callback function:



function api_method($data) {
var_dump($data);


An endpoint needs to return its data, it cannot output it directly as var_dump would, otherwise the returned data is invalid JSON.



Finally, the methods parameter is incorrect:



'methods' => 'GET, POST',


methods doesn't take a comma separated list, no docs suggest doing this either. Instead, use the predefined values provided by the REST API such as WP_REST_Server::READABLE or WP_REST_Server::ALLMETHODS, these are all mentioned in the handbook and the official documentation for register_rest_route.



A better route to register would be:



 register_rest_route( 'my-project/form/v1', '/action', array(


Giving us:



example.com/wp-json/my-project/form/v1/action



Notice how I removed the plugin URL and the redundant /api fragment ( it's obvious it's an API already )






share|improve this answer















Here's your problem:



register_rest_route( plugin_dir_url(__DIR__).'my-project/api/v1/form', '/action', array(


Specifically the idea that this is possible:



http://my-domain.local/wp-content/plugins/my-project/api/v1/form


This is extremely unusual, and runs counter to what's in the docs, handbook, and tutorials.



REST API endpoints live at the REST API, which lives at the URL returned by rest_url(). They live at yoursite.com/wp-json. An endpoint is not a full URL path, or an independent API disconnected from the main API.



Instead, you need to define your endpoint names in terms of namespaces and endpoints, and visit the correct URL as described in the REST API's discovery mechanisms.



If we use this:



register_rest_route( plugin_dir_url(__DIR__).'my-project/api/v1/form', '/action', array(


Then we would expect this:



example.com/wp-json/wp-content/plugins/my-project/api/v1/form/action



That URL is quite long, and has a number of problems:



  • The first parameter is a namespace, not a URL

  • it's not possible to correctly separate out v1 of the API from v2 due to the way that that /form component has been put in the first parameter, not the second. The first parameter is a namespace, the second a route


  • /action is /action, it doesn't get swapped out for GET OR POST

There are also problems with the callback function:



function api_method($data) {
var_dump($data);


An endpoint needs to return its data, it cannot output it directly as var_dump would, otherwise the returned data is invalid JSON.



Finally, the methods parameter is incorrect:



'methods' => 'GET, POST',


methods doesn't take a comma separated list, no docs suggest doing this either. Instead, use the predefined values provided by the REST API such as WP_REST_Server::READABLE or WP_REST_Server::ALLMETHODS, these are all mentioned in the handbook and the official documentation for register_rest_route.



A better route to register would be:



 register_rest_route( 'my-project/form/v1', '/action', array(


Giving us:



example.com/wp-json/my-project/form/v1/action



Notice how I removed the plugin URL and the redundant /api fragment ( it's obvious it's an API already )







share|improve this answer














share|improve this answer



share|improve this answer








edited 5 hours ago

























answered 7 hours ago









Tom J NowellTom J Nowell

33.2k44899




33.2k44899







  • 1





    Thank you for detailed explanation. I've already marked an answer that came quicker as solution however.

    – TTT
    7 hours ago











  • You can change your mind about which answer is best, but eitherway think of the site as a wiki, there can be more than 1 good answer

    – Tom J Nowell
    5 hours ago











  • One reason why I don't want to change answer is that I have conretely tested and applied the answer I selected as solution. Your answer brought more details and things I had thought in a wrong way somehow, but I haven't litteraly tested and checked it all. I also think that on most StackExchange sites, first good answers get selected, next one get votes. And though this has me scratching my head a bit, I see no reason to remove the solution rewards from the person who solved it first.

    – TTT
    5 hours ago












  • 1





    Thank you for detailed explanation. I've already marked an answer that came quicker as solution however.

    – TTT
    7 hours ago











  • You can change your mind about which answer is best, but eitherway think of the site as a wiki, there can be more than 1 good answer

    – Tom J Nowell
    5 hours ago











  • One reason why I don't want to change answer is that I have conretely tested and applied the answer I selected as solution. Your answer brought more details and things I had thought in a wrong way somehow, but I haven't litteraly tested and checked it all. I also think that on most StackExchange sites, first good answers get selected, next one get votes. And though this has me scratching my head a bit, I see no reason to remove the solution rewards from the person who solved it first.

    – TTT
    5 hours ago







1




1





Thank you for detailed explanation. I've already marked an answer that came quicker as solution however.

– TTT
7 hours ago





Thank you for detailed explanation. I've already marked an answer that came quicker as solution however.

– TTT
7 hours ago













You can change your mind about which answer is best, but eitherway think of the site as a wiki, there can be more than 1 good answer

– Tom J Nowell
5 hours ago





You can change your mind about which answer is best, but eitherway think of the site as a wiki, there can be more than 1 good answer

– Tom J Nowell
5 hours ago













One reason why I don't want to change answer is that I have conretely tested and applied the answer I selected as solution. Your answer brought more details and things I had thought in a wrong way somehow, but I haven't litteraly tested and checked it all. I also think that on most StackExchange sites, first good answers get selected, next one get votes. And though this has me scratching my head a bit, I see no reason to remove the solution rewards from the person who solved it first.

– TTT
5 hours ago





One reason why I don't want to change answer is that I have conretely tested and applied the answer I selected as solution. Your answer brought more details and things I had thought in a wrong way somehow, but I haven't litteraly tested and checked it all. I also think that on most StackExchange sites, first good answers get selected, next one get votes. And though this has me scratching my head a bit, I see no reason to remove the solution rewards from the person who solved it first.

– TTT
5 hours ago










TTT is a new contributor. Be nice, and check out our Code of Conduct.









draft saved

draft discarded


















TTT is a new contributor. Be nice, and check out our Code of Conduct.












TTT is a new contributor. Be nice, and check out our Code of Conduct.











TTT is a new contributor. Be nice, and check out our Code of Conduct.














Thanks for contributing an answer to WordPress Development Stack Exchange!


  • Please be sure to answer the question. Provide details and share your research!

But avoid


  • Asking for help, clarification, or responding to other answers.

  • Making statements based on opinion; back them up with references or personal experience.

To learn more, see our tips on writing great answers.




draft saved


draft discarded














StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fwordpress.stackexchange.com%2fquestions%2f333999%2fwhy-is-my-custom-api-endpoint-not-working%23new-answer', 'question_page');

);

Post as a guest















Required, but never shown





















































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown

































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown







Popular posts from this blog

Are there any AGPL-style licences that require source code modifications to be public? Planned maintenance scheduled April 23, 2019 at 23:30 UTC (7:30pm US/Eastern) Announcing the arrival of Valued Associate #679: Cesar Manara Unicorn Meta Zoo #1: Why another podcast?Force derivative works to be publicAre there any GPL like licenses for Apple App Store?Do you violate the GPL if you provide source code that cannot be compiled?GPL - is it distribution to use libraries in an appliance loaned to customers?Distributing App for free which uses GPL'ed codeModifications of server software under GPL, with web/CLI interfaceDoes using an AGPLv3-licensed library prevent me from dual-licensing my own source code?Can I publish only select code under GPLv3 from a private project?Is there published precedent regarding the scope of covered work that uses AGPL software?If MIT licensed code links to GPL licensed code what should be the license of the resulting binary program?If I use a public API endpoint that has its source code licensed under AGPL in my app, do I need to disclose my source?

2013 GY136 Descoberta | Órbita | Referências Menu de navegação«List Of Centaurs and Scattered-Disk Objects»«List of Known Trans-Neptunian Objects»

Mortes em março de 2019 Referências Menu de navegação«Zhores Alferov, Nobel de Física bielorrusso, morre aos 88 anos - Ciência»«Fallece Rafael Torija, o bispo emérito de Ciudad Real»«Peter Hurford dies at 88»«Keith Flint, vocalista do The Prodigy, morre aos 49 anos»«Luke Perry, ator de 'Barrados no baile' e 'Riverdale', morre aos 52 anos»«Former Rangers and Scotland captain Eric Caldow dies, aged 84»«Morreu, aos 61 anos, a antiga lenda do wrestling King Kong Bundy»«Fallece el actor y director teatral Abraham Stavans»«In Memoriam Guillaume Faye»«Sidney Sheinberg, a Force Behind Universal and Spielberg, Is Dead at 84»«Carmine Persico, Colombo Crime Family Boss, Is Dead at 85»«Dirigent Michael Gielen gestorben»«Ciclista tricampeã mundial e prata na Rio 2016 é encontrada morta em casa aos 23 anos»«Pagan Community Notes: Raven Grimassi dies, Indianapolis pop-up event cancelled, Circle Sanctuary announces new podcast, and more!»«Hal Blaine, Wrecking Crew Drummer, Dies at 90»«Morre Coutinho, que editou dupla lendária com Pelé no Santos»«Cantor Demétrius, ídolo da Jovem Guarda, morre em SP»«Ex-presidente do Vasco, Eurico Miranda morre no Rio de Janeiro»«Bronze no Mundial de basquete de 1971, Laís Elena morre aos 76 anos»«Diretor de Corridas da F1, Charlie Whiting morre aos 66 anos às vésperas do GP da Austrália»«Morreu o cardeal Danneels, da Bélgica»«Morreu o cartoonista Augusto Cid»«Morreu a atriz Maria Isabel de Lizandra, de "Vale Tudo" e novelas da Tupi»«WS Merwin, prize-winning poet of nature, dies at 91»«Atriz Márcia Real morre em São Paulo aos 88 anos»«Mauritanie: décès de l'ancien président Mohamed Mahmoud ould Louly»«Morreu Dick Dale, o rei da surf guitar e de "Pulp Fiction"»«Falleció Víctor Genes»«João Carlos Marinho, autor de 'O Gênio do Crime', morre em SP»«Legendary Horror Director and SFX Artist John Carl Buechler Dies at 66»«Morre em Salvador a religiosa Makota Valdina»«مرگ بازیکن‌ سابق نساجی بر اثر سقوط سنگ در مازندران»«Domingos Oliveira morre no Rio»«Morre Airton Ravagniani, ex-São Paulo, Fla, Vasco, Grêmio e Sport - Notícias»«Morre o escritor Flavio Moreira da Costa»«Larry Cohen, Writer-Director of 'It's Alive' and 'Hell Up in Harlem,' Dies at 77»«Scott Walker, experimental singer-songwriter, dead at 76»«Joseph Pilato, Day of the Dead Star and Horror Favorite, Dies at 70»«Sheffield United set to pay tribute to legendary goalkeeper Ted Burgin who has died at 91»«Morre Rafael Henzel, sobrevivente de acidente aéreo da Chapecoense»«Morre Valery Bykovsky, um dos primeiros cosmonautas da União Soviética»«Agnès Varda, cineasta da Nouvelle Vague, morre aos 90 anos»«Agnès Varda, cineasta francesa, morre aos 90 anos»«Tania Mallet, James Bond Actress and Helen Mirren's Cousin, Dies at 77»e