Day03 api

INTERVIEW WITH A MOBILE DEVELOPER
Sara (MISS_ANDROID_94) is a Mobile Developer
She is a lovely person
She loves every one except the back end team
her company
They caused so many problems for her and
wasted her time and energy
Lets dig deeper in Sara’s problems

SOME OF SARA’S PROBLEMS
 Any changes in request / response structure done in the
back end breaks a feature in Sara’s app that takes time to
be working
 No consistency across the API in terms of data formats,
Json structure, status codes
 No navigation links are sent, so I have to
construct/concatenate all URIs of the API’s resources
 No proper documentation to use the API with examples

1- VERSIONING
API versioning is another feature we should
implement to achieve the robustness that is
especially important for mobile apps. Mobile
developers don't always have the luxury of
forcing software updates for all end users, so
our API is going to have to be able to handle
both old and new requests. We'll do this by
routing requests with a version number.

3- CONSISTENCY
Data Formats always JSON
JSON structure (single out put function
for all success and errors)
When dealing with dates and times,
remember that consistency is key.

DOCUMENTATION STEPS
Install npm with nodejs
Install APIDOC
Npm install apidoc –g

 Create a configuration file for apidoc
like this one
 Document your functions like this ->

 Run command
apidoc -i Model/ -o apidoc/
 Enjoy the help for your API
 Send it to the front end and
Mobile team or any team that
will consume your REST API

PHP AND XML
XML is another data formats to use
with API beside JSON
Human Readable
Easy to parse and Query
Better structural

WILL YOU CHOOSE JSON OR XML IN
THESE SITUATIONS AND WHY?
1. You are Designing a Backend in your company for a Mobile
and front end web team to have an interface to manage
some data (CRUD operations)
2. You are working in a tourism API for hotel availability (like
booking.com) and returning data about room types ,
availabilities, prices and amenities ( internet , breakfast,..etc)
this API will be consumed by many other websites .
3. You are making an API for prayer times per city that will be
consumed by many websites

CONVERT PHP ARRAY TO XML
Code Output

XML CLASSES IN PHP
AddChiled($key,$valu
e)
AddAttribute
($key,$value)
AsXML($filename)

PARSING XML TO PHP ARRAY
Code OutPut

PARSE RSS FEED
RSS Feed
 RSS Feed ( example) It is a way to easily distribute a
list of headlines, update notices, and sometimes content
to a wide number of people.
 The wonderful thing about RSS feeds is that they all
implement the same basic structure. Every feed
contains a wrapping "channel" tag. Then, each posting
in your feed will be wrapped within an "item" tag. All of
the information that we need can be accessed this way.

SOAP AND WSDL
SOAP
 A - WSDL is the standard format
for describing a web service.
 B - WSDL definition describes how
to access a web service and what
operations it will perform.
 C - WSDL is a language for
describing how to interface with
XML-based services
WSDL
 Simple Object access protocol
 RPC style services
 Uses WSDL
 Based on XML only
 One URL with methods as
parameters
 SOAP UI

COMPARISON SHEET
REST
 Mainly JSON based but can use XML and text
 Only HTTP
 One end point per resource (pretty URL)
 offer an effective way for interacting with
lightweight clients, such as smartphones.
 A REST client is more like a browser. It's a
generic client that knows how to use a
protocol and standardized methods,
 70% of public APIs are REST
SOAP
 XML based
 HTTP and other protocols (SMTP)
 WSDL
 One end point
 SOAP, the client needs previous knowledge on
everything it will be using, or it won't even
begin the interaction

SOAP
Simple Object Access
Protocol
Uses XML
WSDL Example :
http://api.radioreference.c
om/soap2/?wsdl&v=latest

SOAP IN PHP
Consuming a SOAP SERVICE
SOAPClient (?)
Think as PHP, what
should the constructor of
this class takes ?
Creating a SOAP Service
SOAPServer(?)
Think as PHP what else
is needed ?

CONSUMING A SOAP SERVICE
1. Make sure SOAP extension is installed in your PHP
 Phpinfo
 Extension_loaded
2. Create object from soapClient Class and pass the WSDL
file of your service to its constructor
3. Call any method of the WSDL
4. Enjoy

LET SEE WE WANT TO CALL THE GET
COUNTRIES LIST FUNCTION

SOAP UI
Can you test same service via just SOAP
UI ?

CREATING A SOAP WEB SERVICE VIA
PHP STEP BY STEP
1. Prepare the class which includes your
methods (api documentation is a MUST)
2. Install PHP2WSDL tool via our sweet
composer
3. Generate the WSDL file for your service
4. Create the service
5. Test by SOAP UI

PREPARE THE CLASS
NO DOCUMENTATION = WSDL PROBLEMS

Day03 api

Recommended

More Related Content

What's hot (20)

Similar to Day03 api (20)

More from ABDEL RAHMAN KARIM (13)

Recently uploaded (20)

Day03 api