I dette Programmering med Yii2-serien, Jeg veileder lesere i bruk av Yii2 Framework for PHP. Du kan også være interessert i min Introduksjon til Yii Framework, som vurderer fordelene med Yii og inneholder en oversikt over hva som er nytt i Yii 2.x.
I dagens veiledning vurderer jeg hvordan du bygger en REST API i Yii for å koble applikasjonen din til skyen, mobilappene og andre tjenester. Jeg veileder deg gjennom Yiis REST APIs hurtigstartguide og gir sammenheng og eksempler på vanlige forespørsler.
Komme i gang med Yii REST APIer
Å bygge REST API'er i Yii er faktisk ganske grei. Du kan utnytte eksisterende MVC-rammeverk, men du oppretter et tydelig tilgangspunkt som du har til hensikt å få tilgang til av ulike typer tjenester (ikke besøkende på nettstedet).
Fordelene ved Yii REST Framework
Yii Framework gir bred støtte og detaljert dokumentasjon for å bygge APIer. Her er noen av de innebygde funksjonene når du bygger APIer:
Rask prototyping med støtte for vanlige APIer for Active Record. Dette gjør at du raskt og enkelt kan avsløre datamodul CRUD-funksjonalitet via en API.
Svarformatforhandling (som standard støtter JSON og XML). Det er innebygd støtte for returdata i vanlige utdataformater.
Tilpassbar objekt serialisering med støtte for valgbare utdatafelt. Det er enkelt å endre hvilke data som returneres.
Riktig formatering av samlingsdata og valideringsfeil.
Støtte for hypermedia som motor av applikasjonsstat (HATEOAS)
Effektiv ruting med riktig HTTP verifikasjonskontroll.
Innebygd støtte for ALTERNATIVER og HODE verb.
Godkjenning og autorisasjon.
Data caching og HTTP caching.
Vurder begrense.
Jeg har ikke mulighet til å ta på alt dette i dag.
Min interesse for REST APIer
I denne episoden vil jeg bygge en API for å la oss manipulere varetabellen jeg opprettet i Twixxr-tjenesten fra denne Twitter API-opplæringen. Men jeg planlegger også å bygge en API for vår oppstartsprosess serie fokus, Meeting Planner. En sikker API vil være nødvendig for å bygge et iOS-program for tjenesten. API-en vil aktivere kommunikasjon mellom mobilappen og skyttjenesten.
Bygg REST Controller
Med Yiis REST-rammeverk, oppretter vi et sluttpunkt for API-en og organiserer kontrollører for hver type ressurs.
Ressursene er i hovedsak vår applikasjons datamodeller. Disse utvider yii \ base \ Model.
Yii \ resten \ UrlRule-klassen gir ferdig ruting som kartlegger vår datamodell til API CRUD-endepunkter:
Opprette et tre som skal fungere som API-endepunkt
I Yii2 Advanced-malen er det et front-end og back-end-tre, og dette er utvidbart. For å skille ut API-funksjonene, oppretter vi et tredje tre for å fungere som et API-endepunkt.
Yii-utvikleren Alex Makarov gir denne hjelpsomme veiledningen for å lage flere trær som jeg fulgte med for å lage mitt tredje tre:
$ cp -R backend api $ cp-R miljøer / dev / backend / environments / dev / api $ cp -R miljøer / prod / backend / environments / prod / api
Deretter brukte jeg Atom-redaktøren til å gjøre en global finne og erstatte "backend" med "api" i det nye apitreet.
Og jeg la til api aliaset til /common/config/bootstrap.php:
Konfigurere URL-rutingen for innkommende forespørsler
I /api/config/main.php, må vi legge til be om[] å analysere oppsett JSON parsing og UrlRule å knytte metoder til modellene og deres sluttpunkter:
Postman viste seg å være avgjørende for å avrunde testen min, da kommandolinjekretsen ikke var lett å konfigurere for POST-innsendinger.
Ser fremover
I tillegg til REST Quickstart-oversikten gir Yii 2.0-dokumentasjonen detaljert informasjon om en rekke andre aspekter ved API-oppretting:
ressurser
Controllers
routing
Svarformatering
Godkjenning
Ressursbegrensning
versjons~~POS=TRUNC
Feilhåndtering
Jeg håper å få muligheten til å utforske flere av disse i fremtidige episoder. Men sikkert, et av de neste trinnene er å opprette en API for møteplanlegger i oppstartsserien.
Til slutt er det ganske enkelt å bygge en grunnleggende REST API med Yii MVC-rammen. Yii-teamet har gjort en god jobb som standardiserer funksjonalitet for et svært viktig krav, REST APIs. Jeg håper du har likt å lære om dem.
Hvis du har spørsmål eller forslag, vennligst legg inn dem i kommentarene. Hvis du vil fortsette med fremtidige Envato Tuts + opplæringsprogrammer og andre serier, vennligst besøk min instruktørside eller følg @reifman. Sjekk sjekk ut min oppstartsserie og møteplanlegger.
Relaterte linker
Yii2 Developer Exchange, min Yii2 ressurs side
Hurtigstart - RESTful Web Services - Den Definitive Guide to Yii 2.0
Share
Hva du skal skape
Accentsconagua
