{"id":157,"date":"2018-11-30T15:53:48","date_gmt":"2018-11-30T15:53:48","guid":{"rendered":"http:\/\/joanalbamaldonado.com\/blog\/?p=157"},"modified":"2018-12-09T14:18:23","modified_gmt":"2018-12-09T14:18:23","slug":"fake_rest_server-rest-server-in-php","status":"publish","type":"post","link":"https:\/\/joanalbamaldonado.com\/blog\/2018\/11\/30\/fake_rest_server-rest-server-in-php\/","title":{"rendered":"fake_rest_server – REST server in PHP"},"content":{"rendered":"

“fake_rest_server<\/a>” is a simple and easy-to-configure REST server made in PHP.<\/p>\n

I made it just to create different REST servers very fast for testing purposes. It was made on 12th May 2016 (approximately).<\/p>\n

It can be found on GitHub: https:\/\/github.com\/jalbam\/fake_rest_server<\/a><\/p>\n

Configuring the server<\/h2>\n

To add new paths (routes) and methods, the developer just needs to create a new folder structure (folder and subfolders if needed) which represents the route and inside one file per method named [method_desired].php<\/em> (for example, put.php<\/em>).<\/p>\n

To start developing your REST server, you will only need to download the files inside the src\/<\/a><\/strong> folder.<\/p>\n

You may want to take a look at the src\/_code\/functions.php<\/a><\/strong> file (the engine will include it automatically) as it provides some basic but useful functions. There you can also add new functions or modify the existing ones.<\/p>\n

If you want to add data, you can use the src\/_code\/data\/data.php<\/a><\/strong> file (automatically included by the engine).<\/p>\n

If you want to add configuration data, you can use the src\/_code\/config.php<\/a><\/strong> file (automatically included by the engine).<\/p>\n

As the engine defines the USING_REST_SERVER<\/strong> constant, you can protect any of the files with the following line at the beginning:<\/p>\n

<?php if (!defined(\"USING_REST_SERVER\") || !USING_REST_SERVER) { return; } ?>\n<\/pre>\n
Note: this authorization code above is also defined in the AUTHORIZATION_CODE<\/strong> constant (inside the the src\/_code\/config.php<\/a><\/strong> file).<\/p>\n
<\/a><\/p>\n
Example:<\/h3>\n
1) In the root folder (where the src\/_code\/<\/a><\/strong> folder and the src\/index.php<\/a><\/strong> file are placed), create a folder called myRESTService\/<\/strong>.<\/p>\n
2) Inside the myRESTService\/<\/strong> folder we have just created, create another folder called user\/<\/strong> and inside of it create two files: index.php<\/strong> and get.php<\/strong>.<\/p>\n
3) Inside the myRESTService\/user\/index.php<\/strong> file, place the following code:<\/p>\n
<?php\n  \/\/Users info (this could be in the \"src\/_code\/config.php\" file, but it is just an example):\n  $usersData = Array\n  (\n    \/\/User IDs:\n    \"1\" =>\n      Array\n      (\n        \"name\" => \"John Doe\",\n        \"favouriteFood\" => \"meat\"\n      ),\n    \"2\" =>\n      Array\n      (\n        \"name\" => \"Joan Alba Maldonado\",\n        \"favouriteFood\" => \"pizza\"\n      )\n  );\n  \n  \/\/Gets the data needed which has been sent through the REST client:\n  $userId = getVariable(\"id\"); \/\/\"getVariable\" and other functions available in the \"src\/_code\/functions.php\" file.\n<\/pre>\n
4) Inside the myRESTService\/user\/get.php<\/strong> file put the following code:<\/p>\n
<?php\n  if ($userId === \"\") { echo \"No id sent!\"; }\n  else if (array_key_exists($userId, $usersData))\n  {\n    echo $usersData[$userId][\"name\"] . \" likes eating \" . $usersData[$userId][\"favouriteFood\"];\n  }\n  else { echo \"User cannot be found! (id=\" . $userId . \")\"; }<\/pre>\n
5) With this, we will have our REST server configured with the myRESTService\/user\/<\/strong> route, accepting the GET<\/strong> method with the id<\/strong> parameter. This example can be found in the example_easy\/<\/a><\/strong> folder.<\/p>\n
Testing the server<\/h2>\n
If you do not have a REST client, the server can be tested on any web browser by adding the debug=1<\/strong> parameter to the URL as well as the method<\/strong> parameter with the method desired (not needed if the method is GET<\/strong>), as for example: http:\/\/localhost\/fake_rest_server\/src\/index.php\/route_1\/subroute?method=post&debug=1&username=Joan<\/em><\/p>\n
Following the example above<\/a>, you can use a web browser to visit the following links:<\/p>\n
http:\/\/localhost\/route_to_the_REST_server\/index.php\/myRESTService\/user\/?method=get&debug=1&id=1<\/em> (it should show “John Doe likes eating meat”)<\/p>\n
http:\/\/localhost\/route_to_the_REST_server\/index.php\/myRESTService\/user\/?method=get&debug=1&id=2<\/em> (it should show “Joan Alba Maldonado likes eating pizza”)<\/p>\n
http:\/\/localhost\/route_to_the_REST_server\/index.php\/myRESTService\/user\/?method=get&debug=1&id=3<\/em> (it should show “User cannot be found! (id=3)”)<\/p>\n
http:\/\/localhost\/route_to_the_REST_server\/index.php\/myRESTService\/user\/?method=get&debug=1<\/em> (it should show “No id sent!”)<\/p>\n
Note that the “\/<\/em>” character at the end of the route is optional.<\/p>\n
Final comments<\/h2>\n
It is very easy to extend using PHP language. The project already includes some examples with routes, methods, functions and data as user accounts, etc. as examples (in both the example\/<\/a><\/strong> and the example_easy\/<\/a><\/strong> folder) but they can be deleted.<\/p>\n
The only really-needed code is located in the src\/<\/a><\/strong> folder. Inside of it, the route_1\/<\/a><\/strong> folder and all of its content can also be deleted since it is just an example.<\/p>\n
License<\/h2>\n
This project can be used, reproduced, distributed and modified freely for any non-commercial purposes but always keeping the author’s name and copyright clauses. Other than that, just use this project as you wish but never sell it!<\/p>\n","protected":false},"excerpt":{"rendered":"
“fake_rest_server” is a simple and easy-to-configure REST server made in PHP. I made it just to create different REST servers very fast for testing purposes. It was made on 12th May 2016 (approximately). It can be found on GitHub: https:\/\/github.com\/jalbam\/fake_rest_server Configuring the server To add new paths (routes) and methods, the developer just needs to … Continue reading “fake_rest_server – REST server in PHP”<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[51,97,49,9,104,105,74,75],"tags":[56,102,60,24,106,107,77,76],"class_list":["post-157","post","type-post","status-publish","format-standard","hentry","category-development","category-library","category-php","category-programming","category-rest","category-server","category-tool","category-utility","tag-development","tag-library","tag-php","tag-programming","tag-rest","tag-server","tag-tool","tag-utility"],"_links":{"self":[{"href":"https:\/\/joanalbamaldonado.com\/blog\/wp-json\/wp\/v2\/posts\/157","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/joanalbamaldonado.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/joanalbamaldonado.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/joanalbamaldonado.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/joanalbamaldonado.com\/blog\/wp-json\/wp\/v2\/comments?post=157"}],"version-history":[{"count":18,"href":"https:\/\/joanalbamaldonado.com\/blog\/wp-json\/wp\/v2\/posts\/157\/revisions"}],"predecessor-version":[{"id":180,"href":"https:\/\/joanalbamaldonado.com\/blog\/wp-json\/wp\/v2\/posts\/157\/revisions\/180"}],"wp:attachment":[{"href":"https:\/\/joanalbamaldonado.com\/blog\/wp-json\/wp\/v2\/media?parent=157"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/joanalbamaldonado.com\/blog\/wp-json\/wp\/v2\/categories?post=157"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/joanalbamaldonado.com\/blog\/wp-json\/wp\/v2\/tags?post=157"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}