In deze Programmeren met de Yii2-serie, Ik leid lezers in gebruik van het Yii2 Framework voor PHP. Mogelijk bent u ook geïnteresseerd in mijn Introductie tot het Yii Framework, die de voordelen van Yii beoordeelt en een overzicht bevat van wat er nieuw is in Yii 2.x.
In de tutorial van vandaag zal ik bekijken hoe een REST API te bouwen in Yii om uw applicatie te verbinden met de cloud, mobiele apps en andere services. Ik zal u door de snelstartgids van Yii's REST API leiden en context en voorbeelden geven van veelvoorkomende verzoeken.
Aan de slag met Yii REST API's
Het bouwen van REST API's in Yii is eigenlijk vrij eenvoudig. U kunt gebruikmaken van het bestaande MVC-framework, maar u maakt een afzonderlijk toegangspunt waarvoor u toegang wilt hebben tot verschillende soorten services (geen websitebezoekers).
De voordelen van het Yii REST-raamwerk
Het Yii Framework biedt brede ondersteuning en gedetailleerde documentatie voor het bouwen van API's. Hier zijn enkele van de ingebouwde mogelijkheden bij het bouwen van API's:
Snelle prototyping met ondersteuning voor algemene API's voor Active Record. Hiermee kunt u snel en gemakkelijk datamodel-CRUD-functionaliteit via een API blootstellen.
Onderhandeling over responsformaten (standaard ondersteunt JSON en XML). Er is ingebouwde ondersteuning voor het retourneren van gegevens in gangbare uitvoerformaten.
Aanpasbare objectserialisatie met ondersteuning voor selecteerbare outputvelden. Het is gemakkelijk om aan te passen welke gegevens worden geretourneerd.
Correct formatteren van verzamelingsgegevens en validatiefouten.
Ondersteuning voor Hypermedia als de engine van applicatie staat (HATEOAS)
Efficiënte routing met de juiste controle van het HTTP-werkwoord.
Ingebouwde ondersteuning voor de OPTIES en HOOFD werkwoorden.
Authenticatie en authorisatie.
Data caching en HTTP caching.
Snelheidsbeperkend.
Ik krijg vandaag geen kans om dit allemaal aan te raken.
Mijn interesse in REST-API's
In deze aflevering zal ik een API maken om de itemtabel die ik in de Twixxr-service heb gemaakt te manipuleren vanuit deze Twitter API-zelfstudie. Maar ik ben ook van plan om een API te bouwen voor onze startup zelfstudiereeks focus, Meeting Planner. Een veilige API is nodig om een iOS-applicatie voor de service te bouwen. De API zorgt voor communicatie tussen de mobiele app en de cloudservice.
De REST-controller bouwen
Met het REST-framework van Yii maken we een eindpunt voor onze API en organiseren we controllers voor elk type resource.
De middelen zijn in essentie de datamodellen van onze applicatie. Deze breiden yii \ base \ Model uit.
De klasse yii \ rest \ UrlRule biedt kant-en-klare routering die ons gegevensmodel toewijst aan API CRUD-eindpunten:
Een boom maken om te fungeren als een API-eindpunt
In de Yii2 Advanced-sjabloon is er een front-end en een back-end-boomstructuur, en deze is uitbreidbaar. Om de API-functies te scheiden, maken we een derde structuur die puur als een API-eindpunt fungeert.
Yii-ontwikkelaar Alex Makarov biedt deze nuttige handleiding voor het maken van extra bomen die ik heb gevolgd om mijn derde stamboom te maken:
$ cp -R backend api $ cp -R environments / dev / backend / environments / dev / api $ cp -R environments / prod / backend / environments / prod / api
Vervolgens gebruikte ik de Atom-editor om een globale vind-en-vervanging van "backend" met "api" in de nieuwe api-tree te maken.
En ik heb de api alias toegevoegd aan /common/config/bootstrap.php:
De URL-routering voor inkomende aanvragen configureren
In /api/config/main.php moeten we het toevoegen verzoek[] om setup JSON-parsing en de UrlRule om methoden voor de modellen en hun eindpunten te associëren:
Postman bleek essentieel om mijn testen af te ronden, omdat het niet gemakkelijk was om Curl te configureren voor POST-inzendingen.
Vooruit kijken
Naast het REST quickstart-overzicht, biedt de Yii 2.0-documentatie informatie over een aantal andere aspecten van het maken van API's:
Middelen
Controllers
routing
Reactieopmaak
authenticatie
Snelheidsbeperking
Versioning
Foutafhandeling
Ik hoop de kans te krijgen om meer van deze te ontdekken in toekomstige afleveringen. Maar zeker, een van de volgende stappen is het maken van een API voor Meeting Planner in de opstartreeks.
Tot slot, het bouwen van een eenvoudige REST API met het Yii MVC-framework is vrij eenvoudig. Het Yii-team heeft uitstekend werk gedaan door de functionaliteit te standaardiseren voor een zeer belangrijke vereiste, REST-API's. Ik hoop dat je het leuk vond om er meer over te leren.
Als je vragen of suggesties hebt, plaats deze dan in de comments. Als je graag mijn toekomstige Envato Tuts + tutorials en andere series wilt volgen, ga dan naar mijn instructeurspagina of volg @reifman. Bekijk zeker mijn opstartserie en Meeting Planner.
Gerelateerde Links
Yii2 Developer Exchange, mijn Yii2-bronsite
Snelle start - RESTful Web Services - De definitieve gids voor Yii 2.0
Share
Wat je gaat creëren
Accentsconagua
