I denna Programmering med Yii2-serien, Jag vägledande läsare som använder Yii2 Framework for PHP. Du kanske också är intresserad av mina Introduktion till Yii Framework, som granskar fördelarna med Yii och innehåller en översikt över vad som är nytt i Yii 2.x.
I dagens handledning granskar jag hur man bygger ett REST API i Yii för att ansluta din applikation till molnet, mobilappar och andra tjänster. Jag guidar dig genom Yiis snabbguide för REST API och ger sammanhang och exempel på vanliga förfrågningar.
Komma igång med Yii REST API
Att bygga REST API i Yii är faktiskt ganska enkelt. Du kan utnyttja befintliga MVC-ramar, men du skapar en distinkt åtkomstpunkt som du tänker komma åt av olika typer av tjänster (inte besökare på webbplatsen).
Fördelarna med Yii REST Framework
Yii Framework erbjuder brett stöd och detaljerad dokumentation för att bygga API: er. Här är några av de inbyggda funktionerna när du bygger API: er:
Snabb prototyper med stöd för gemensamma API för Active Record. Detta gör att du snabbt och enkelt kan utsätta data-modellen CRUD-funktionalitet via ett API.
Svarformatförhandling (stödjer JSON och XML som standard). Det finns inbyggt stöd för att återställa data i vanliga utdataformat.
Anpassningsbar objekt serialisering med stöd för valbara utmatningsfält. Det är enkelt att ändra vilken data som returneras.
Korrekt formatering av insamlingsdata och valideringsfel.
Stöd för hypermedia som motor för ansökningsstaten (HATEOAS)
Effektiv routing med korrekt HTTP verb kontroll.
Inbyggt stöd för ALTERNATIV och HUVUD verb.
Godkännande och godkännande.
Datakachning och HTTP-caching.
Ränta begränsning.
Jag kommer inte att ha chans att röra på allt detta idag.
Min intresse för REST APIs
I det här avsnittet ska jag bygga ett API för att vi ska kunna manipulera den produkttabell jag skapade i Twixxr-tjänsten från denna Twitter API-handledning. Men jag planerar också att bygga ett API för vårt startfält seriefokus, mötesplanerare. Ett säkert API är nödvändigt för att bygga en iOS-applikation för tjänsten. API: n kommer att möjliggöra kommunikation mellan mobilappen och molntjänsten.
Bygga REST Controller
Med Yiis REST-ramar skapar vi en slutpunkt för vårt API och organiserar controllers för varje typ av resurs.
Resurserna är i huvudsak vår applikations datamodeller. Dessa sträcker sig yii \ base \ Model.
Yii \ resten \ UrlRule-klassen ger färdiglagd routing som kartlägger vår datamodell till API CRUD-ändpunkter:
Skapa ett träd för att fungera som API-slutpunkt
I den avancerade mallen Yii2 finns det ett front-end- och backend-träd, och detta är utökbart. För att skilja ut API-funktionerna skapar vi ett tredje träd för att fungera som en API-ändpunkt.
Yii-utvecklaren Alex Makarov ger den här hjälpsamma guiden för att skapa ytterligare träd som jag följde för att skapa mitt tredje träd:
$ cp -R backend api $ cp -R-miljöer / dev / backend / environments / dev / api $ cp -R-miljöer / prod / backend / environments / prod / api
Sedan använde jag Atom-redaktören för att göra en global find och ersätta "backend" med "api" i det nya apiträdet.
Och jag lade till api alias till /common/config/bootstrap.php:
Konfigurera URL-routing för inkommande förfrågningar
I /api/config/main.php, måste vi lägga till begäran[] att analysera setup JSON-analysering och UrlRule att associera metoder för modellerna och deras slutpunkter:
Postman visade sig vara avgörande för att runda ut testningen eftersom kommandoradskrull inte var lätt att konfigurera för POST-inlägg.
Blickar framåt
Förutom sin REST snabbstartsöversikt, innehåller Yii 2.0-dokumentationen detaljer om en rad andra aspekter av API-skapandet:
Medel
controllers
routing
Svarformatering
autentisering
Räntebegränsning
versionshantering
Felhantering
Jag hoppas kunna få chansen att utforska mer av dessa i framtida episoder. Men säkert är ett av de följande stegen att skapa ett API för mötesplaneraren i startserien.
Slutligen är det ganska enkelt att bygga ett grundläggande REST API med Yii MVC-ramverket. Yii-laget har gjort ett bra jobb att standardisera funktionaliteten för ett mycket viktigt krav, REST API. Jag hoppas att du har haft lust om dem.
Om du har några frågor eller förslag, vänligen skicka in dem i kommentarerna. Om du vill hålla koll på mina framtida Envato Tuts + handledning och andra serier, besök min instruktörssida eller följ @reifman. Kolla in min start-serie och mötesplanerare.
relaterade länkar
Yii2 Developer Exchange, min Yii2 resurs webbplats
Snabbstart - RESTful Web Services - Den Definitive Guide till Yii 2.0
Share
Vad du ska skapa
Accentsconagua
