webapi.xml 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. <?xml version="1.0"?>
  2. <!--
  3. /**
  4. * Copyright © 2016 Ihor Vansach (ihor@magefan.com). All rights reserved.
  5. * See LICENSE.txt for license details (http://opensource.org/licenses/osl-3.0.php).
  6. *
  7. * Glory to Ukraine! Glory to the heroes!
  8. */
  9. -->
  10. <routes xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../app/code/Magento/Webapi/etc/webapi.xsd">
  11. <!-- Login Example to get Bearer: curl -X POST "http://mystore.com/index.php/rest/V1/integration/admin/token" \
  12. -H "Content-Type:application/json" \
  13. -d '{"username":"username", "password":"userpassword"}' -->
  14. <!-- Example: curl -X POST "http://mystore.com/index.php/rest/V1/blog/post" \
  15. -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  16. -H "Content-Type:application/json" \
  17. -d '{"data":"{\"title\":\"value_1\",\"content\":"Test",\"is_active\":1,\"store_ids\":\"0\"}"}' -->
  18. <route url="/V1/blog/post" method="POST">
  19. <service class="Magefan\Blog\Api\PostManagementInterface" method="create"/>
  20. <resources>
  21. <resource ref="Magefan_Blog::post"/>
  22. </resources>
  23. </route>
  24. <!-- Example: curl -X PUT "http://mystore.com/index.php/rest/V1/blog/post/:id" \
  25. -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  26. -H "Content-Type:application/json" \
  27. -d '{"data":"{\"title\":\"value_1\",\"content\":"Test2",\"is_active\":1,\"store_ids\":\"0\"}"}' -->
  28. <route url="/V1/blog/post/:id" method="PUT">
  29. <service class="Magefan\Blog\Api\PostManagementInterface" method="update"/>
  30. <resources>
  31. <resource ref="Magefan_Blog::post"/>
  32. </resources>
  33. </route>
  34. <!-- Example: curl -X DELETE "http://mystore.com/index.php/rest/V1/blog/post/:id" \
  35. -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -->
  36. <route url="/V1/blog/post/:id" method="DELETE">
  37. <service class="Magefan\Blog\Api\PostManagementInterface" method="delete"/>
  38. <resources>
  39. <resource ref="Magefan_Blog::post"/>
  40. </resources>
  41. </route>
  42. <!-- Example: curl "http://mystore.com/index.php/rest/V1/blog/post/:id" \
  43. -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -->
  44. <route url="/V1/blog/post/:id" method="GET">
  45. <service class="Magefan\Blog\Api\PostManagementInterface" method="get"/>
  46. <resources>
  47. <resource ref="Magefan_Blog::post"/>
  48. </resources>
  49. </route>
  50. <!-- Example: curl "http://mystore.com/index.php/rest/V1/blog/post/view/:id/:store_id" -->
  51. <route url="/V1/blog/post/view/:id/:store_id" method="GET">
  52. <service class="Magefan\Blog\Api\PostManagementInterface" method="view"/>
  53. <resources>
  54. <resource ref="anonymous" />
  55. </resources>
  56. </route>
  57. <!-- Example: curl "http://mystore.com/index.php/rest/V1/blog/post/list/:type/:term/:store_id/:page/:limit" -->
  58. <route url="/V1/blog/post/list/:type/:term/:store_id/:page/:limit" method="GET">
  59. <service class="Magefan\Blog\Api\PostManagementInterface" method="getList"/>
  60. <resources>
  61. <resource ref="anonymous" />
  62. </resources>
  63. </route>
  64. <!-- Example: curl -X POST "http://mystore.com/index.php/rest/V1/blog/category" \
  65. -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  66. -H "Content-Type:application/json" \
  67. -d '{"data":"{\"param_1\":\"value_1\",\"param_2\":\"value_2\",\"param_n\":\"value_n\"}"}' -->
  68. <route url="/V1/blog/category" method="POST">
  69. <service class="Magefan\Blog\Api\CategoryManagementInterface" method="create"/>
  70. <resources>
  71. <resource ref="Magefan_Blog::category"/>
  72. </resources>
  73. </route>
  74. <!-- Example: curl -X PUT "http://mystore.com/index.php/rest/V1/blog/category/:id" \
  75. -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  76. -H "Content-Type:application/json" \
  77. -d '{"data":"{\"param_1\":\"new_value_1\",\"param_2\":\"new_value_2\",\"param_n\":\"new_value_n\"}"}' -->
  78. <route url="/V1/blog/category/:id" method="PUT">
  79. <service class="Magefan\Blog\Api\CategoryManagementInterface" method="update"/>
  80. <resources>
  81. <resource ref="Magefan_Blog::category"/>
  82. </resources>
  83. </route>
  84. <!-- Example: curl -X DELETE "http://mystore.com/index.php/rest/V1/blog/category/:id" \
  85. -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -->
  86. <route url="/V1/blog/category/:id" method="DELETE">
  87. <service class="Magefan\Blog\Api\CategoryManagementInterface" method="delete"/>
  88. <resources>
  89. <resource ref="Magefan_Blog::category"/>
  90. </resources>
  91. </route>
  92. <!-- Example: curl "http://mystore.com/index.php/rest/V1/blog/category/:id" \
  93. -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -->
  94. <route url="/V1/blog/category/:id" method="GET">
  95. <service class="Magefan\Blog\Api\CategoryManagementInterface" method="get"/>
  96. <resources>
  97. <resource ref="Magefan_Blog::category"/>
  98. </resources>
  99. </route>
  100. <!-- Example: curl "http://mystore.com/index.php/rest/V1/blog/category/view/:id/:store_id" -->
  101. <route url="/V1/blog/category/view/:id/:store_id" method="GET">
  102. <service class="Magefan\Blog\Api\CategoryManagementInterface" method="view"/>
  103. <resources>
  104. <resource ref="anonymous" />
  105. </resources>
  106. </route>
  107. </routes>