phpughh: apigility

APIGILITYAPIGILITYHeute klicken wir unsere API einfach mal zusammen...Heute klicken wir unsere API einfach mal zusammen...

1 / 42

HeuteHeuteMit Quiz!Mit Quiz!

Über Ralf EggertÜber Ralf Eggert

2 / 42

[B00]

PrologProlog

3 / 42

[B01]

4 / 42

Neue APINeue APIin zwei in zwei Stunden?Stunden?

[B02]

5 / 42

Nimm dochNimm dochApigility!Apigility!

[B03]

In a NutshellIn a Nutshell

6 / 42

Restful Web ServicesRestful Web Services

7 / 42

CLIENT

Web Browser

PHP

Javascript

RUBY

PYTHON

REST SERVER

/api/user/123

/api/user

/api/user

/api/user/123

/api/user/123

USER DOMAIN

getUserEntity()

getUserCollection()

addUserEntity()

updateUserEntity()

deleteUserEntity()

GET Request

JSON Response

GET Request

JSON Response

POST Request

JSON Response

PUT Request

JSON Response

DELETE Request

JSON Response

Integer

UserEntity

void

UserCollection

Array

Boolean

Integer, Array

Boolean

Integer

Boolean

RPC Web ServicesRPC Web Services

8 / 42

LocalCLIENT

javascript

RPCClient

JSON

Method:getUserParams:id

USER DOMAIN

getUserEntity()

GET Request

JSON Result

Integer

UserEntity

RPCServer

/json-rpc.php

Remote Call

JSON Result

javascriptJSON

Method:addUserParams:name

addUserEntity()

POST Request

JSON Result

Array

Boolean

/json-rpc.php

Remote Call

JSON Result

javascriptXML

Method:getUserParams:id

getUserEntity()

GET Request

XML Result

Integer

UserEntity

/xml-rpc.php

Remote Call

XML Result

javascriptXML

Method:addUserParams:name

addUserEntity()

POST Request

XML Result

Array

Boolean

/xml-rpc.php

Remote Call

XML Result

VersionierungVersionierung

default Version per URLdefault Version per URL

Version 1 per URLVersion 1 per URL

Version 2 per URLVersion 2 per URL

default Version per Content Negotiationdefault Version per Content Negotiation

Version 1 per Content NegotiationVersion 1 per Content Negotiation

Version 2 per Content NegotiationVersion 2 per Content Negotiation

9 / 42

JSON / HAL / ProblemJSON / HAL / Problem

10 / 42

WEITERE FEATURESWEITERE FEATURES

Datenbank-basiertDatenbank-basiert Code-basiertCode-basiert authentifizierungauthentifizierung

API DokumentationAPI Dokumentation DatenvalidierungDatenvalidierung DeploymentDeployment

11 / 42

[B04] [B05][B05] [B06]

[B07] [B08][B08] [B09][B09]

ModularisierungModularisierungZf-apigilityZf-apigility Zf-apigility-adminZf-apigility-admin Zf-apigility-documentationZf-apigility-documentation

Zf-apigility-documentation-swaggerZf-apigility-documentation-swagger Zf-apigility-providerZf-apigility-provider Zf-apigility-WelcomeZf-apigility-Welcome

Zf-api-problemZf-api-problem Zf-configurationZf-configuration Zf-content-negotiationZf-content-negotiation

Zf-content-validationZf-content-validation Zf-deployZf-deploy Zf-development-modeZf-development-mode

Zf-halZf-hal Zf-mvc-authZf-mvc-auth Zf-oauth2Zf-oauth2

Zf-restZf-rest Zf-RPCZf-RPC Zf-versioningZf-versioning

12 / 42

InstallationInstallationCurl und Composer$ curl -s https://getcomposer.org/installer | php --$ php composer.phar create-project -sdev zfcampus/zf-apigility-skeleton /path/to/install$ cd /path/to/install

ZIP und Composer$ wget https://github.com/zfcampus/zf-apigility-skeleton/archive/master.zip$ unzip -d /path/to/install master.zip $ cd /path/to/install$ php composer.phar install

Git und Composer$ git clone https://github.com/zfcampus/zf-apigility-skeleton.git /path/to/install$ cd /path/to/install$ php composer.phar install

Entwicklungsmodus einschalten und Rechte setzen$ php public/index.php development enable$ sudo chmod 777 -R config/$ sudo chmod 777 -R data/$ sudo chmod 777 -R module/

13 / 42

StartseiteStartseite

14 / 42

[B04]

DB-basierterDB-basierterREST-ServiceREST-Service

15 / 42

DatenbankmodellDatenbankmodell

16 / 42

DatenbankadapterDatenbankadapter

Schritte 1 bis 6Schritte 1 bis 617 / 42

Rest Service, DB-basiertRest Service, DB-basiert

Schritte 1 bis 6Schritte 1 bis 618 / 42

Rest Service, DB-basiertRest Service, DB-basiert

19 / 42Schritte 7 bis 12Schritte 7 bis 12

Rest Service, DB-basiertRest Service, DB-basiert

20 / 42Schritte 13 bis 18Schritte 13 bis 18

REST Service User ListeREST Service User Liste

21 / 42

REST Service User EntityREST Service User Entity

22 / 42

[B10]

POSTPOSTPUTPUT

DELETEDELETE23 / 42

Rest Service Post IRest Service Post I

24 / 42Schritte 1 bis 3Schritte 1 bis 3

Rest Service Post IIRest Service Post II

25 / 42Schritte 4 bis 6Schritte 4 bis 6

Rest Service Put IRest Service Put I

26 / 42Schritte 1 bis 3Schritte 1 bis 3

Rest Service Put IIRest Service Put II

27 / 42Schritt 4Schritt 4

Rest Service DeleteRest Service Delete

28 / 42Schritte 1 bis 3Schritte 1 bis 3

[B06]

AUTHENTIFI-AUTHENTIFI-ZIERUNGZIERUNG

29 / 42

Authentifizierung IAuthentifizierung I

HTpasswd$ htpasswd -c data/htpasswd apigilityNew password: *********Re-type new password: *********Adding password for user apigility$

OAUTH2HTTP DIGESTHTTP BASIC

30 / 42

Authentifizierung IIAuthentifizierung II

31 / 42Schritte 1 bis 6Schritte 1 bis 6

Authentifizierung IIIAuthentifizierung III

32 / 42Schritt 7Schritt 7

Authentifizierung IVAuthentifizierung IV

33 / 42Schritt 8Schritt 8

[B05]

Code-basierterCode-basierterREST SERVICE?REST SERVICE?

34 / 42

[B11]

35 / 42

Beim Beim NächstenNächstenMal...Mal...

[B00]

EPILOGEPILOG

36 / 42

[B12]

37 / 42

Und wann Und wann kommtkommtDas Quiz?Das Quiz?

[B02]

38 / 42

Frage 1:Frage 1:Aus wie vielen Aus wie vielen einzelnen Modulen einzelnen Modulen wurde Apigility wurde Apigility aufgebaut?aufgebaut?

[B02]

39 / 42

Frage 2:Frage 2:Welche Arten Welche Arten von Webservices von Webservices werden werden unterstützt?unterstützt?

[B02]

40 / 42

Frage 3:Frage 3:Welche HTTP Welche HTTP Methoden haben Methoden haben wir implementiert?wir implementiert?

APIGILITYAPIGILITYKlappt für einfache APIs, ansonsten ist Handarbeit erforderlich...Klappt für einfache APIs, ansonsten ist Handarbeit erforderlich...

Repository: https://github.com/RalfEggert/phpughh-apigility

41 / 42

BildnachweisBildnachweis[B00] Fotos von Ralf Eggert

[B01] Still here https://www.flickr.com/photos/thenovys/3784261365 von Abe Novy - CC-BY https://creativecommons.org/licenses/by/2.0/

[B02] Young student https://www.flickr.com/photos/audiolucistore/14159712431/ von www.audio-luci-store.it - CC-BY https://creativecommons.org/licenses/by/2.0/

[B03] Acorns https://www.flickr.com/photos/dno1967b/5431273344 von Daniel Oines - CC-BY https://creativecommons.org/licenses/by/2.0/

[B04] Fixing the database https://www.flickr.com/photos/dahlstroms/4140461901 von Håkan Dahlström - CC-BY https://creativecommons.org/licenses/by/2.0/

[B05] Monaco 14pt https://www.flickr.com/photos/polarity/3138680190 von Robert Agthe - CC-BY https://creativecommons.org/licenses/by/2.0/

[B06] RSA Securid Token - Credit Card Style https://www.flickr.com/photos/purpleslog/265657780 von Purple Slog - CC-BY https://creativecommons.org/licenses/by/2.0/

[B07] Shelf of Used Books https://www.flickr.com/photos/thedarkthing/5363586197 von William Ross - CC-BY https://creativecommons.org/licenses/by/2.0/

[B08] Ticket validator at Nice train station https://www.flickr.com/photos/traveleden/3797157077 von Simon - CC-BY https://creativecommons.org/licenses/by/2.0/

[B09] Test Lab - Supermicro Storage https://www.flickr.com/photos/jemimus/8533890844 von Robert - CC-BY https://creativecommons.org/licenses/by/2.0/

[B10] We are all fan of laptops https://www.flickr.com/photos/scottvanderchijs/4493248747 von Scott & Elaine van der Chijs - CC-BY https://creativecommons.org/licenses/by/2.0/

[B11] Laugh https://www.flickr.com/photos/wounded/4105835342 von Simon Claassen - CC-BY https://creativecommons.org/licenses/by/2.0/

[B12] Surprise https://www.flickr.com/photos/photographybycolby/11927931295 von Colby Stopa - CC-BY https://creativecommons.org/licenses/by/2.0/

Alle weiteren Screenshots wurden von Ralf Eggert erstellt.

42 / 42