From fa8c8fa0db55bb9cf0d8c9905a98fae64b4ae191 Mon Sep 17 00:00:00 2001 From: Phil Davis Date: Fri, 7 Aug 2015 10:07:00 +0545 Subject: [PATCH] Dev App API minor corrections --- developer_manual/app/api.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/developer_manual/app/api.rst b/developer_manual/app/api.rst index 0bf65919b..3415c02a7 100644 --- a/developer_manual/app/api.rst +++ b/developer_manual/app/api.rst @@ -4,7 +4,7 @@ RESTful API .. sectionauthor:: Bernhard Posselt -Offering a RESTful API is not different from creating a :doc:`route ` and :doc:`controllers ` for the web interface. It is recommended though to inherit from ApiController and add **@CORS** annotations to the methods so that `also web applications will be able to access the API `_. +Offering a RESTful API is not different from creating a :doc:`route ` and :doc:`controllers ` for the web interface. It is recommended though to inherit from ApiController and add **@CORS** annotations to the methods so that `web applications will also be able to access the API `_. .. code-block:: php @@ -29,7 +29,7 @@ Offering a RESTful API is not different from creating a :doc:`route ` an } -CORS also needs a separate URL for the preflighted **OPTIONS** request that easily be added by adding the following route: +CORS also needs a separate URL for the preflighted **OPTIONS** request that can easily be added by adding the following route: .. code-block:: php @@ -43,7 +43,7 @@ CORS also needs a separate URL for the preflighted **OPTIONS** request that easi ) -Keep in mind that multiple apps will likely depend on the API interface once it is published and they will move at different speeds to react on changes implemented in the API. Therefore it is recommended to version the API in the URL to not break existing apps when backwards incompatible changes are introduced:: +Keep in mind that multiple apps will likely depend on the API interface once it is published and they will move at different speeds to react to changes implemented in the API. Therefore it is recommended to version the API in the URL to not break existing apps when backwards incompatible changes are introduced:: /index.php/apps/myapp/api/1.0/resource