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

"as much details as you can remember"

Multiply Two Integer Polynomials

Did Section 31 appear in Star Trek: The Next Generation?

What does "fetching by region is not available for SAM files" means?

Is a "Democratic" Oligarchy-Style System Possible?

Is an up-to-date browser secure on an out-of-date OS?

Worn-tile Scrabble

Does a dangling wire really electrocute me if I'm standing in water?

Loose spokes after only a few rides

How to obtain Confidence Intervals for a LASSO regression?

Why did Acorn's A3000 have red function keys?

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

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

Return to UK after being refused entry years previously

How to manage monthly salary

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

Why was M87 targetted for the Event Horizon Telescope instead of Sagittarius A*?

Identify boardgame from Big movie

How to answer pointed "are you quitting" questioning when I don't want them to suspect

Is this app Icon Browser Safe/Legit?

Why isn't airport relocation done gradually?

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

Are there incongruent pythagorean triangles with the same perimeter and same area?

The difference between dialogue marks



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
    8 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
    2 hours 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
    8 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
    2 hours 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 9 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
    8 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
    2 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
    8 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
    2 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
8 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
8 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
2 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
2 hours 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
    8 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
    8 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
    8 hours ago






  • 2





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

    – Tom J Nowell
    8 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
    7 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
    8 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
    6 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
    6 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
    8 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
    8 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
    8 hours ago






  • 2





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

    – Tom J Nowell
    8 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
    7 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
    8 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
    8 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
    8 hours ago






  • 2





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

    – Tom J Nowell
    8 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
    7 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 6 hours ago

























answered 9 hours ago









leymannxleymannx

85411122




85411122












  • 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
    8 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
    8 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
    8 hours ago






  • 2





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

    – Tom J Nowell
    8 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
    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
    8 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
    8 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
    8 hours ago






  • 2





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

    – Tom J Nowell
    8 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
    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
8 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
8 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
8 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
8 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
8 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
8 hours ago




2




2





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

– Tom J Nowell
8 hours ago





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

– Tom J Nowell
8 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
7 hours ago





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

– TTT
7 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
    8 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
    6 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
    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
    8 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
    6 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
    6 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 6 hours ago

























answered 8 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
    8 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
    6 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
    6 hours ago












  • 1





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

    – TTT
    8 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
    6 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
    6 hours ago







1




1





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

– TTT
8 hours ago





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

– TTT
8 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
6 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
6 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
6 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
6 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

How to create a command for the “strange m” symbol in latex? Announcing the arrival of Valued Associate #679: Cesar Manara Planned maintenance scheduled April 23, 2019 at 23:30 UTC (7:30pm US/Eastern)How do you make your own symbol when Detexify fails?Writing bold small caps with mathpazo packageplus-minus symbol with parenthesis around the minus signGreek character in Beamer document titleHow to create dashed right arrow over symbol?Currency symbol: Turkish LiraDouble prec as a single symbol?Plus Sign Too Big; How to Call adfbullet?Is there a TeX macro for three-legged pi?How do I get my integral-like symbol to align like the integral?How to selectively substitute a letter with another symbol representing the same letterHow do I generate a less than symbol and vertical bar that are the same height?

Category:Tremithousa Media in category "Tremithousa"Navigation menuUpload media34° 49′ 02.7″ N, 32° 26′ 37.32″ EOpenStreetMapGoogle EarthProximityramaReasonatorScholiaStatisticsWikiShootMe

Dokschytsy (Steed) Kwelen | NawigatsjuunBelarus: Vitebsk Region, citypopulation.de