Apigility Integration in Zend Studio

To create an Apigility project:

1. In Zend Studio, go to File | New | Apigility Project.
   -OR-
   In the PHP Explorer View, right-click and select New | Project | Apigility Project.
   The New Apigility Project wizard is displayed.

2. Name your new project.
3. Select the file location of the new project.
4. Select an existing server for deploying the new server project, or click Add Server to create a new server. For information on adding new servers, see Managing PHP Servers.

5. Click Next.
   The Templates dialog is displayed.

6. From the Available Templates list, select the Empty Apigility Project template, and click Finish.
   Your new Apigility project is created, and the Apigility Editor is displayed in the PHP Explorer.

   Note:

   The Apigility Editor UI requires certain Composer dependencies. These will be added to the project now, together with Composer Support.

   

To add a new service to Apigility:

1. At the top of the Apigility Editor, click APIs.
   The APIs page s displayed.

2. Click the Create New API button.
   The Create New API dialog is displayed.

3. Name your new API, and click Create API.
   Your new API is created and opened.

4. From the menu, click RPC Services.
   The RPC Services page is displayed.

5. Click the Create New RPC Service button.
   The Create a new RPC service dialog is displayed.

6. Enter the following details:
   • RPC Service Name - name of the service (ping)
   • Route to match - the route of the service (/ping)
7. Click Create RPC Service.
   The new service is created and listed on the RPC Services page.

Well done! You have successfully created your new web service in Apigility.

To document services:

1. Click the bar with the service name to expand it.

2. Click the Fields tab.

3. Hover over the colored bar for the service.

4. You will see three buttons appear, a yellow Test Service button , a green Edit Service button , and a red Delete Service button .
   Click the Edit Service button, to enter a new field for the service.

5. In the Field name text area, enter a value ('ack'), and click the Create New Field button.

6. Expand the new panel with the field name.

7. Enter a description, and click Save Changes.

   The new field is saved along with the description.

8. Click the Documentation tab.

9. As with the fields, hover over the colored bar for the service, and click the green Edit Service button to edit the documentation.

10. Add a service description, and a description for the GET method.

11. When done, click the Generate from configuration button to auto-fill the Response Body, and click the Save button.
    Congrats! Your service is documented.

To develop the service:

1. Click the Source Code tab.

2. Apigility created a new service controller in your project. Click the file link.
   The service controller file is opened.

3. Edit the file so the code looks as follows:

<?php
namespace ping\V1\Rpc\Ping;
 
use Zend\Mvc\Controller\AbstractActionController;
use ZF\ContentNegotiation\ViewModel;
 
class PingController extends AbstractActionController
{
	public function pingAction()
	{
		return new ViewModel(array(
			'ack'=>time(),
		));
	}
}

The important lines are lines 05, which imports 'ZF\ContentNegotiation\ViewModel', and lines 11-13, which return a view model from the controller.

4. Save the file.
   

To test the service:

1. Open the Apigility Editor.

   Tip:

   The Apigility Editor can be opened by right-clicking the project in the PHP Explorer, and selecting Open Apigility Editor.

2. Hover over the colored bar of the service, and click the yellow Test Service button .
   The Test Service view is displayed.

3. The URL field displays the service path. Note that the GET method is selected and the 'ack' field is displayed in the request parameters table.
4. Click the adjacent Test icon .
   Results are displayed in the Response window.
   You should receive a '200 OK' response, with a timestamp returned for the 'ack' parameter.

Well done! You have successfully completed this tutorial. For information on how to use Apigility in Zend Studio to develop your mobile applications, see Developing Mobile Applications with Zend Studio.

For more information on working with Apigility, see Apigility.org.

To add and test authentication:

1. In the Apigility Editor, open the service page.

2. Click the Authorization menu item.
   The Authorization page is displayed.

3. Select the GET check-box, and click Save.

   The GET method is now inaccessible unless a user provides valid credentials to the API.

4. Validate this by clicking the Test icon in the Test Service view to test the GET method again.
   A '403 Forbidden' response is displayed.

5. On the Authorization page, and click the link to the authentication screen.
   The Authentication page is displayed.

6. Click the HTTP Basic authentication method.
   The Setup HTTP Basic Authentication window is displayed.

7. Enter the following information:

   • Authentication Realm - The Authentication Realm for the HTTP Basic Authentication (e.g., API)
   • Location of htpasswd file - Location of the 'htpasswd' file in your file system (e.g., data/htpasswd)
8. Click Save.
   Zend Studio creates a new' htpasswd' file in the location you selected, which is displayed in the PHP editor.

9. Click Add User.
   The Add user dialog is displayed.

10. Enter a user name and password in the designated fields, and click OK.
    The user is added to the 'htpasswd' file.
11. Save the file.
12. In the Test Service view, select the Authentication required check-box below the method types.
    The Service authentication dialog is displayed.

13. Enter the same user credentials, and click OK.
    The authentication details are added to the request header.

14. Click the Test icon .
    Results are displayed in the Response window.
    You should receive a '200 OK' response, with a timestamp returned for the 'ack' parameter.

Congratulations! You have completed the Apigility Integration tutorial. We recommend you see the Developing Mobile Applications with Zend Studio tutorial for information on using Apigility as the back-end of your mobile projects.