RESTful-verkkopalveluiden opetusohjelma: REST API -esimerkki

Miksi käyttää Restful-verkkopalveluita?

Ennen teknisten yksityiskohtien tutkimista on hyödyllistä ymmärtää, miksi RESTistä tuli niin suosittu. RESTful-verkkopalvelut nousivat kuuluisuuteen seuraavista syistä:

1. Heterogeeniset kielet ja ympäristöt – Tämä on yksi perustavanlaatuisista syistä, ja se on sama kuin mitä olemme nähneet aiemminkin. SAIPPUA samoin.

• Se mahdollistaa eri ohjelmointikielillä rakennettujen verkkosovellusten kommunikoinnin keskenään.
• Restful-palveluiden avulla nämä verkkosovellukset voivat sijaita erilaisissa ympäristöissä; jotkut voivat olla päällä Windows, ja muut voivat olla Linuxissa.

Loppujen lopuksi, ympäristöstä riippumatta, tuloksen tulisi aina olla sama: sovellusten tulisi pystyä kommunikoimaan keskenään. Restful-verkkopalvelut tarjoavat tätä joustavuutta eri ohjelmointikielille ja alustoille rakennetuille sovelluksille.

Alla oleva kuva antaa esimerkin verkkosovelluksesta, jonka on oltava yhteydessä muihin sovelluksiin, kuten Facebookiin, Twitteriin ja... Google.

Jos asiakassovelluksen pitäisi toimia Facebookin ja Twitterin kaltaisten sivustojen kanssa, kehittäjien pitäisi yleensä tietää, millä kielellä ja alustalla kyseiset sivustot on rakennettu. Tämän perusteella he voisivat kirjoittaa rajapintakoodin, mutta tämän lähestymistavan ylläpitäminen voisi osoittautua painajaiseksi.

Sen sijaan Facebook, Twitter ja Google paljastavat niiden toiminnallisuuden Restful-verkkopalveluiden muodossa. Tämä sallii minkä tahansa asiakassovelluksen kutsua näitä verkkopalveluita REST-yhteyden kautta riippumatta taustalla olevasta teknologiasta.

2. Laitteiden tapahtuma – Nykyään kaiken on toimittava Puhelinnumero laitteita, olipa kyseessä sitten matkapuhelin, kannettava tietokone tai jopa auton järjestelmä.

Kuvittele, kuinka paljon vaivaa vaaditaan sovellusten koodaamiseen näillä laitteilla, jotta ne kommunikoivat tavallisten verkkosovellusten kanssa. Jälleen kerran Restful-APIt yksinkertaistavat tätä työtä, koska, kuten ensimmäisessä kohdassa mainittiin, sinun ei oikeastaan ​​tarvitse tietää laitteen taustalla olevaa tasoa.

3. Pilvitapahtuma – Kaikki siirtyy pilveen. Sovellukset siirtyvät hitaasti pilvipohjaisiin järjestelmiin, kuten Azure or Amazon. Azure ja Amazon tarjoavat monia Restful-arkkitehtuuriin perustuvia API-rajapintoja. Siksi sovellukset on nyt kehitettävä siten, että ne ovat yhteensopivia pilven kanssa. Koska kaikki pilvipohjaiset arkkitehtuurit toimivat REST-periaatteella, on järkevää ohjelmoida verkkopalvelut REST-pohjaiselle arkkitehtuurille, jotta pilvipalveluita voidaan hyödyntää parhaalla mahdollisella tavalla.

RESTful Key Elements

REST-verkkopalvelut ovat kehittyneet paljon perustamisestaan ​​lähtien. Vuonna 2002 Web-konsortio julkaisi WSDL- ja SOAP-verkkopalveluiden määritelmän. Tämä muodosti standardin verkkopalveluiden toteutukselle.

Vuonna 2004 verkkokonsortio julkaisi myös RESTful-nimisen lisästandardin määritelmän. Viime vuosina tästä standardista on tullut melko suosittu, ja sitä käyttävät nyt monet maailman suosituimmista verkkosivustoista, kuten Facebook ja Twitter.

REST on tapa käyttää tietyssä ympäristössä sijaitsevia resursseja. Sinulla voi esimerkiksi olla palvelin, joka isännöi tärkeitä asiakirjoja, kuvia tai videoita. Kaikki nämä ovat esimerkkejä resursseista. Jos asiakas, kuten verkkoselain, tarvitsee jotakin näistä resursseista, sen on lähetettävä pyyntö palvelimelle. REST-palvelut määrittelevät vakiotavan, jolla näihin resursseihin voidaan päästä käsiksi.

RESTful-toteutuksen avainelementit ovat seuraavat:

1. Esittelymateriaalit – Ensimmäinen keskeinen elementti on itse resurssi. Oletetaan, että palvelimella olevassa verkkosovelluksessa on useiden työntekijöiden tiedot. Oletetaan, että URL verkkosovelluksesta on https://demo.guru99.comJotta työntekijätietoresurssiin päästään käsiksi REST-palveluiden kautta, voidaan antaa komento https://demo.guru99.com/employee/1Tämä komento käskee web-palvelinta antamaan tiedot työntekijästä, jonka työntekijänumero on 1.
2. Pyydä verbejä – Nämä kuvaavat, mitä haluat tehdä resurssilla. Selain antaa GET-verbin ohjeistaakseen päätepistettä hakemaan dataa. Käytettävissä on kuitenkin monia muita verbejä, kuten POST, PUT ja DELETE. Joten esimerkin tapauksessa https://demo.guru99.com/employee/1, verkkoselain itse asiassa antaa GET-verbin, koska se haluaa saada työntekijätietueen tiedot.
3. Pyydä otsikot – Nämä ovat pyynnön mukana lähetettyjä lisäohjeita. Ne voivat määrittää vaadittavan vastauksen tyypin tai valtuutustiedot.
4. Pyynnön elin – Tämä on pyynnön mukana lähetettävä data. Data lähetetään normaalisti pyynnön rungossa, kun REST-verkkopalvelulle tehdään POST-pyyntö. POST-kutsussa asiakas kertoo REST-verkkopalvelulle haluavansa lisätä resurssin palvelimelle. Näin ollen pyynnön rungossa olisi tiedot lisättävästä resurssista.
5. Response Body – Tämä on vastauksen pääosa. Jos siis RESTful API -esimerkissämme kyselisimme web-palvelinta pyynnön kautta https://demo.guru99.com/employee/1, web-palvelin saattaa palauttaa XML-dokumentin, joka sisältää kaikki työntekijän tiedot vastauksen rungossa.
6. Vastauksen tilakoodit – Nämä ovat yleisiä koodeja, jotka palautetaan web-palvelimen vastauksen mukana. Esimerkki on koodi 200, joka palautetaan normaalisti, kun asiakkaalle palautettaessa vastausta ei ole virhettä.

Rauhoittavat menetelmät

Alla oleva kaavio näyttää useimmat verbit (POST, GET, PUT ja DELETE) ja REST API -esimerkin siitä, mitä ne tarkoittaisivat.

Oletetaan, että meillä on RESTful-verkkopalvelu määriteltynä sijainnissa https://demo.guru99.com/employeeKun asiakas tekee pyynnön tälle verkkopalvelulle, se voi määrittää minkä tahansa normaaleista HTTP-verbeistä: GET, POST, DELETE ja PUT. Alla on kuvattu, mitä tapahtuisi, jos asiakas lähettäisi kyseiset verbit.

1. POST – Tätä käytettäisiin uuden työntekijän luomiseen RESTful-verkkopalvelun avulla.
2. SAA – Tätä käytettäisiin kaikkien RESTful-verkkopalvelua käyttävien työntekijöiden luettelon hankkimiseen.
3. PUT – Tätä käytettäisiin kaikkien RESTful-verkkopalvelua käyttävien työntekijöiden tietojen päivittämiseen.
4. POISTA – Tätä käytettäisiin kaikkien RESTful-palvelua käyttävien työntekijöiden poistamiseen.

Tarkastellaan nyt asiaa yhden tietueen näkökulmasta. Oletetaan, että työntekijätietueella on työntekijänumero 1. Seuraavilla toimilla olisi omat merkityksensä.

1. POST – Tämä ei olisi sovellettavissa, koska haemme työntekijän 1 tietoja, jotka on jo luotu.
2. SAA – Tätä käytettäisiin työntekijänumeron 1 tietojen hakemiseen RESTful-verkkopalvelun avulla.
3. PUT – Tätä käytettäisiin työntekijänumerolla 1 varustetun työntekijän tietojen päivittämiseen RESTful-verkkopalvelun avulla.
4. POISTA – Tätä käytetään työntekijänumeron 1 omaavan työntekijän tietojen poistamiseen.

Rauhallinen Archirakenne

RESTful- tai REST-tyyliseksi katsottavalla sovelluksella tai arkkitehtuurilla on seuraavat ominaisuudet.

1. Tila ja toiminnallisuus on jaettu hajautettuihin resursseihin – Tämä tarkoittaa, että jokaiseen resurssiin tulisi olla pääsy normaaleilla HTTP-komennoilla GET, POST, PUT tai DELETE. Jos joku haluaa noutaa tiedoston palvelimelta, hänen tulisi pystyä tekemään GET-pyyntö ja noutamaan tiedosto. Jos he haluavat tallentaa tiedoston palvelimelle, heidän tulisi pystyä tekemään joko POST- tai PUT-pyyntö. Lopuksi, jos he haluavat poistaa tiedoston palvelimelta, he voivat tehdä DELETE-pyynnön.

2. Arkkitehtuuri on asiakas/palvelin-pohjainen, tilaton, kerrostettu ja tukee välimuistia.

• Client-server on tyypillinen arkkitehtuuri, jossa palvelin voi olla sovellusta isännöivä web-palvelin ja asiakas voi olla yhtä yksinkertainen kuin verkkoselain.
• Tilaton tarkoittaa, että sovelluksen tilaa ei ylläpidetä REST:ssä. Jos esimerkiksi poistat resurssin palvelimelta DELETE-komennolla, et voi odottaa, että poistotiedot välitetään seuraavaan pyyntöön.

Resurssin poistamisen varmistamiseksi sinun on lähetettävä GET-pyyntö. GET-pyyntöä käytetään ensin kaikkien palvelimella olevien resurssien hakemiseen, minkä jälkeen on tarkistettava, onko resurssi todella poistettu.

RESTFul periaatteet ja rajoitukset

REST-arkkitehtuuri perustuu muutamiin ominaisuuksiin, joita käsitellään tarkemmin alla. Minkä tahansa RESTful-verkkopalvelun on täytettävä alla olevat ominaisuudet, jotta sitä voidaan kutsua RESTfuliksi. Näitä ominaisuuksia kutsutaan myös suunnitteluperiaatteiksi, joita on noudatettava työskenneltäessä RESTful-pohjaisten palveluiden kanssa.

1. RESTFul Client-Server

   

Tämä on REST-pohjaisen arkkitehtuurin perustavanlaatuisin vaatimus. Se tarkoittaa, että palvelimella on RESTful-verkkopalvelu, joka tarjoaa asiakkaalle tarvittavat toiminnot. Asiakas lähettää pyynnön palvelimella olevalle verkkopalvelulle. Palvelin joko hylkää pyynnön tai suostuu siihen ja antaa asiakkaalle riittävän vastauksen.

2. kansalaisuudeton

Tilattoman käsite tarkoittaa, että asiakkaan on varmistettava, että palvelimelle toimitetaan kaikki tarvittavat tiedot. Tämä on välttämätöntä, jotta palvelin voi käsitellä vastauksen asianmukaisesti. Palvelimen ei tule säilyttää minkäänlaisia ​​tietoja asiakkaan pyyntöjen välillä. Se on hyvin yksinkertainen, itsenäinen kysymys-vastaus-sekvenssi. Asiakas esittää kysymyksen, ja palvelin vastaa siihen asianmukaisesti. Kun asiakas esittää toisen kysymyksen, palvelin ei muista edellistä kysymys-vastaus-skenaariota ja sen on vastattava uuteen kysymykseen itsenäisesti.

3. Kätkö

Välimuistikonsepti auttaa edellisessä kohdassa kuvatun tilattomuuden ongelman ratkaisemisessa. Koska jokainen palvelin-asiakaspyyntö on luonteeltaan itsenäinen, asiakas saattaa joskus pyytää palvelimelta samaa pyyntöä uudelleen, vaikka se olisi jo pyytänyt sitä aiemmin. Tämä pyyntö menee palvelimelle, ja palvelin antaa vastauksen, mikä lisää verkkoliikennettä. Välimuisti on asiakkaalla toteutettu konsepti, joka tallentaa palvelimelle jo lähetetyt pyynnöt. Joten jos asiakas tekee saman pyynnön, se ei mene palvelimelle, vaan välimuistiin ja hakee tarvittavat tiedot. Tämä säästää edestakaisen verkkoliikenteen asiakkaan ja palvelimen välillä.

4. Kerrostettu järjestelmä

Kerrosjärjestelmän käsite on, että asiakkaan ja RESTFul-verkkopalvelua isännöivän varsinaisen palvelimen väliin voidaan lisätä mikä tahansa lisäkerros, kuten väliohjelmistokerros. (Väliohjelmistokerros on se, missä kaikki liiketoimintalogiikka luodaan. Tämä voi olla ylimääräinen palvelu, jonka kanssa asiakas on vuorovaikutuksessa ennen kuin se soittaa verkkopalveluun.) Mutta tämän kerroksen käyttöönoton on oltava läpinäkyvää, jotta se ei häiritse asiakkaan ja palvelimen välistä vuorovaikutusta.

5. Käyttöliittymä/yhtenäinen liitäntätract

Tämä on RESTful-verkkopalveluiden toiminnan perusta. RESTful toimii pohjimmiltaan HTTP-verkkotasolla ja käyttää alla olevia avainsanoja palvelimen resurssien kanssa työskentelyyn.

• POST – Resurssin luominen palvelimelle.
• GET – Hakee resurssin palvelimelta.
• PUT – Resurssin tilan muuttaminen tai sen päivittäminen.
• POISTA – Resurssin poistaminen palvelimelta.

REST vs. SOAP: Keskeiset erot

Kehittäjät usein vertailevat RESTiä SOAPiin suunnitellessaan verkkopalvelua. Molemmat mahdollistavat hajautettujen sovellusten kommunikoinnin, mutta ne eroavat jyrkästi toisistaan ​​filosofiansa osalta. REST on arkkitehtuurityyli, joka käyttää yksinkertaisia ​​HTTP-verbejä ja kevyitä formaatteja, kuten JSON, kun taas SAIPPUA on tiukka protokolla, joka perustuu XML-kirjekuoriin ja muodolliseen con-koodiin.tract. Alla oleva taulukko esittää yhteenvedon tärkeimmistä eroista.

Käytännössä REST on oletusvalinta julkisille verkko- ja mobiilisovellusliittymille, koska se on nopeampi ja helpompi käyttää, kun taas SOAP on edelleen hyödyllinen yritysjärjestelmille, jotka vaativat sisäänrakennettua tietoturvaa ja muodollista valvontaa.tracts.

Luo ensimmäinen Restful-verkkopalvelusi ASP.NETissä

Tässä REST API -opetusohjelmassa opimme nyt luomaan Restful-verkkopalvelun ASP.NETissä.

Verkkopalveluita voidaan luoda useilla eri kielillä, ja REST-pohjaisten palveluiden luomiseen voidaan käyttää monia integroituja kehitysympäristöjä.

Tässä RESTful API -esimerkissä luomme REST-sovelluksemme .NETissä Visual Studiota käyttäen. Meillä tulee olemaan Restful-verkkopalvelu, joka toimii alla olevan datajoukon parissa.

Alla oleva datajoukko edustaa REST API -esimerkkiä yrityksestä, joka paljastaa tutoriaalinsa Tutorialid:n perusteella.

REST API -opetusohjelman esimerkissä toteutamme alla olevat Restful-verbit.

1. HANKI opetusohjelma – Kun asiakas käynnistää tämän Restful-rajapinnan, hän saa käyttöönsä kaikki verkkopalvelusta saatavilla olevat tutoriaalit.
2. GET Tutorial/Tutorialid – Kun asiakas käynnistää tämän Restful-rajapinnan, hänelle annetaan tutoriaalin nimi asiakkaan lähettämän Tutorialid:n perusteella.
3. POST-opetusohjelma/opetusohjelman nimi – Kun asiakas käynnistää tämän Restful-rajapinnan, se lähettää pyynnön opetusohjelman nimen lisäämiseksi. Verkkopalvelu lisää sitten lähetetyn opetusohjelman nimen kokoelmaan.
4. POISTA Opastus/Tutorialid – Kun asiakas käynnistää tämän Restful-rajapinnan, se lähettää pyynnön Tutorialname-nimen poistamiseksi Tutorialid-arvon perusteella. Verkkopalvelu poistaa sitten lähetetyn tutoriaalin nimen kokoelmasta.

Noudatetaan alla olevia ohjeita luodaksemme ensimmäisen RESTful-verkkopalvelumme, joka suorittaa yllä olevan toteutuksen.

Kuinka luoda ensimmäinen rauhallinen verkkopalvelu

Vaihe 1) Luo uusi projekti.
Ensimmäinen askel on luoda tyhjä Asp.Net verkkosovellus. Napsauta Visual Studio 2013:ssa valikkovaihtoehtoa Tiedosto->Uusi projekti.

Kun napsautat Uusi projekti -vaihtoehtoa, Visual Studio näyttää sinulle toisen valintaikkunan projektityypin valitsemiseksi ja tarvittavien tietojen syöttämiseksi. Tämä selitetään seuraavassa vaiheessa.

Vaihe 2) Syötä projektin nimi ja sijainti.

1. Varmista, että valitset ensin C# ASP.NET-verkkosovelluksen verkkomalli. Projektin on oltava tätä tyyppiä, jotta verkkopalveluprojekti voidaan luoda. Valitsemalla tämän vaihtoehdon Visual Studio suorittaa tarvittavat vaiheet tarvittavien tiedostojen lisäämiseksi mille tahansa verkkopohjaiselle sovellukselle.
2. Anna projektille nimi, joka meidän tapauksessamme on ”Webservice.REST”.
3. Varmista sitten, että annat sijainnin, johon projektitiedostot tallennetaan.

Kun olet valmis, näet luodun projektitiedoston Visual Studio 2013:n ratkaisunhallinnassa.

Vaihe 3) Luo verkkopalvelutiedosto.
Seuraava vaihe on luoda web-palvelutiedosto, joka tulee sisältämään RESTful-web-palvelun.

1. Napsauta ensin hiiren kakkospainikkeella projektitiedostoa alla olevan kuvan mukaisesti.

2. Tässä vaiheessa
   1. Napsauta projektitiedostoa hiiren kakkospainikkeella.
   2. Valitse vaihtoehto ”Lisää -> Uusi kohde”.

Näyttöön tulevassa valintaikkunassa sinun on suoritettava seuraavat toimet.

1. Valitse vaihtoehto WCF-palvelu (Ajax-yhteensopiva). Tämän tyyppisen tiedoston valitseminen saa Visual Studion lisäämään peruskoodia, jonka avulla voit luoda RESTful-verkkopalvelun. WCF on lyhenne sanoista Windows Viestintä FoundationWCF on kirjasto eri alustojen (tai saman alustan) sovelluksille kommunikointiin eri protokollien, kuten TCP:n, HTTP:n ja HTTPS:n, kautta. Ajax on asynkroninen. JavaKäsikirjoitus ja XML. AJAX mahdollistaa verkkosivujen päivityksen asynkronisesti vaihtamalla pieniä määriä tietoa kulissien takana olevan palvelimen kanssa.
2. Seuraavaksi anna palvelulle nimi, joka meidän tapauksessamme on TutorialService.
3. Napsauta lopuksi Lisää-painiketta lisätäksesi palvelun ratkaisuun.

Vaihe 4) Tee konfiguraatio.
Seuraava vaihe on tehdä kokoonpanomuutos, jotta tämä projekti voi toimia RESTful-verkkopalveluiden kanssa. Tämä edellyttää muutosta tiedostoon nimeltä Web.configTämä tiedosto näkyy samassa ikkunassa kuin Webservice-projektitiedosto. Web.config-tiedosto sisältää kaikki määritykset, jotka saavat web-sovelluksen toimimaan normaalisti. Tehtävä muutos sallii sovelluksen lähettää ja vastaanottaa tietoja puhtaana RESTful-web-palveluna.

1. Avaa koodi napsauttamalla Web.config-tiedostoa.

2. Etsi linja .

3. Muuta riviä muotoon .

Vaihe 5) Lisää koodimme käyttöönottoa varten.
Seuraava vaihe on koodin lisääminen toteutusta varten. Kaikki alla oleva koodi on kirjoitettava TutorialService.svc-tiedostoon.

1. Ensimmäinen vaihe on lisätä koodia, joka edustaa ohjelmassamme käytettävää dataa. Meillä on siis lista merkkijonomuuttujia, joiden arvot ovat "Arrays", "Queues" ja "Stacks". Tämä edustaa webhotellipalvelumme kautta saatavilla olevien tutoriaalien nimiä.

namespace Webservice.REST
{
[ServiceContract(Namespace = "")]
[AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
public class TutorialService
{
private static List<String> lst = new List<String>
(new String[] {"Arrays","Queues","Stacks"});

Vaihe 6) Määritä koodi GET-menetelmällemme.
Seuraavaksi määrittelemme GET-metodin koodin. Tämä koodi sijaitsee myös samassa TutorialService.svc-tiedostossa. Tämä koodi suoritetaan aina, kun kutsumme palvelua selaimestamme.

Alla olevaa menetelmää käytetään alla olevan skenaarion täyttämiseen.

• Jos käyttäjä haluaa listan kaikista saatavilla olevista tutoriaaleista, hänen on kirjoitettava alla oleva koodi tämän saavuttamiseksi.

[WebGet(UriTemplate = "/Tutorial")]

public String GetAllTutorial()
{
    int count = lst.Count;
    String TutorialList = "";
    for (int i = 0; i < count; i++)
        TutorialList = TutorialList + lst[i] + ",";
    return TutorialList;
}

Code Selitys:-

1. Ensimmäinen koodirivi on tärkein. Sitä käytetään määrittelemään, miten voimme kutsua tätä metodia a:n kautta. URLJoten jos linkki verkkopalveluumme on http://localhost:52645/TutorialService.svc ja lisäämme '/Tutorial'-sanan URL, kuten http://localhost:52645/TutorialService.svc/Tutorial, yllä oleva koodi kutsutaan. 'WebGet'-attribuutti on parametri, joka sallii tämän metodin olla RESTful-metodi, jotta sitä voidaan kutsua GET-verbin kautta.
2. Tätä koodin osaa käytetään käymään läpi lst-muuttujan merkkijonoluettelomme ja palauttamaan ne kaikki kutsuvaan ohjelmaan.

Vaihe 7) Palauta tulos.
Alla oleva koodi varmistaa, että jos Tutorial-palveluun tehdään GET-kutsu Tutorial-tunnuksella, se palauttaa vastaavan tutoriaalin nimen Tutorial-tunnuksen perusteella.

[WebGet(UriTemplate = "/Tutorial/{Tutorialid}")]

public String GetTutorialbyID(String Tutorialid)
{
    int pid;
    Int32.TryParse(Tutorialid, out pid);
    return lst[pid];
}

Code Selitys:-

1. Ensimmäinen koodirivi on tärkein. Se määrittelee, kuinka voimme kutsua tätä metodia a:n kautta. URLJoten jos linkki verkkopalveluumme on http://localhost:52645/TutorialService.svc ja lisäämme '/Tutorial/{Tutorialid}'-kohdan loppuun URL, voisimme kutsua verkkopalvelua seuraavasti http://localhost:52645/TutorialService.svc/Tutorial/1esimerkiksi. Verkkopalvelu palauttaisi sitten opetusohjelman nimen, jonka opetusohjelman tunnus on 1.
2. Tätä koodin osaa käytetään palauttamaan opetusohjelman nimi, jolla on web-metodille välitetty opetusohjelman tunniste.

• Oletusarvoisesti on muistettava, että kaikki, mikä välitetään URL selaimessa on merkkijono.
• Mutta sinun on muistettava, että listamme indeksin on oltava kokonaisluku, joten lisäämme tarvittavan koodin muuntaaksemme ensin Tutorialid:n kokonaisluvuksi.
• Sitten käytämme sitä listamme indeksisijainnin käyttämiseen ja palautamme arvon kutsuvalle ohjelmalle vastaavasti.

Vaihe 8) Kirjoita POST-metodin koodi.
Seuraava vaihe on kirjoittaa koodi POST-metodia varten. Tätä metodia kutsutaan aina, kun haluamme lisätä merkkijonoarvon tutoriaalien luetteloon POST-metodin avulla. Jos esimerkiksi haluat lisätä tutoriaalin nimen "Ohjelmistotestaus", sinun on käytettävä POST-metodia.

[WebInvoke(Method = "POST", RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped,
UriTemplate = "/Tutorial/{str}")]

public void AddTutorial(String str)
{
    lst.Add(str);
}

Code Selitys:-

1. Ensimmäinen rivi on 'WebInvoke'-attribuutti, joka on liitetty metodiimme. Tämä mahdollistaa metodin kutsumisen POST-kutsun kautta. RequestFormat- ja ResponseFormat-attribuutit on mainittava JSON-muodossa, koska RESTFul-verkkopalveluun lähetettävien arvojen on oltava tässä muodossa.
2. Toista koodiriviä käytetään POST-kutsussa välitetyn merkkijonon arvon lisäämiseen olemassa olevaan tutoriaalimerkkijonojen luetteloon.

Vaihe 9) Lisää metodi DELETE-toiminnon käsittelemiseksi.
Lopuksi lisäämme metodin DELETE-operaation käsittelemiseksi. Tätä metodia kutsutaan aina, kun haluamme poistaa olemassa olevan merkkijonoarvon tutoriaaliluettelostamme DELETE-metodin avulla.

[WebInvoke(Method = "DELETE", RequestFormat = WebMessageFormat.Json,
UriTemplate = "/Tutorial/{Tutorialid}", ResponseFormat = WebMessageFormat.Json,
BodyStyle = WebMessageBodyStyle.Wrapped)]

public void DeleteTutorial(String Tutorialid)
{
    int pid;
    Int32.TryParse(Tutorialid, out pid);
    lst.RemoveAt(pid);
}

Code Selitys:-

1. Ensimmäinen rivi on 'WebInvoke'-attribuutti, joka on liitetty metodiimme. Tämä mahdollistaa metodin kutsumisen DELETE-kutsulla. RequestFormat- ja ResponseFormat-attribuutit on mainittava JSON-muodossa, koska arvojen on oltava tässä muodossa. Huomaa, että Method-parametri asetetaan arvoon ”DELETE”. Tämä tarkoittaa, että aina kun annamme DELETE-verbin, tätä metodia kutsutaan.
2. Toisella koodirivillä otetaan DELETE-kutsun kautta lähetetty Tutorialid ja sen jälkeen poistetaan tämä tunnus luettelostamme. ( Int32 koodin funktiota käytetään muuntaakseen Tutorial-tunnuksen merkkijono-muuttujasta kokonaisluvuksi.)

Ensimmäisen Restful-verkkopalvelusi käyttäminen

Nyt kun olemme luoneet koko verkkopalvelumme yllä olevassa osiossa, katsotaanpa, miten voimme suorittaa Tutorial-palvelun niin, että sitä voidaan kutsua mistä tahansa asiakasohjelmasta.

Suorittaaksesi verkkopalvelun, noudata alla olevia ohjeita.

Vaihe 1) Napsauta hiiren kakkospainikkeella projektitiedostoa – Webservice.REST.

Vaihe 2) Valitse valikkovaihtoehto 'Aseta käynnistysprojektiksi'. Tämä varmistaa, että tämä projekti suoritetaan, kun Visual Studio suorittaa koko ratkaisun.

Vaihe 3) Seuraava vaihe on itse projektin suorittaminen. Järjestelmään asennetusta oletusselaimesta riippuen sopivan selaimen nimi näkyy Visual Studion suorituspainikkeen vieressä. Meidän tapauksessamme meillä on Google Chrome ilmestyy. Napsauta vain tätä painiketta.

Lähtö: -

Kun projekti on suoritettu, voit selata TutorialService.svc/Tutorial-osioon ja saada alla olevan tulosteen.

Yllä olevassa tulosteessa

• Näet, että selain kutsuu 'GET'-verbiä ja suorittaa 'GetAllTutorial'-metodia verkkopalvelussa. Tätä moduulia käytetään kaikkien verkkopalvelumme tarjoamien opetusohjelmien näyttämiseen.

Testataan ensimmäistä Restful-verkkopalveluasi

Yllä olevassa osiossa olemme jo nähneet, miten selainta käytetään 'GET'-verbin suorittamiseen ja 'GetAllTutorial'-funktion kutsumiseen.

1. Suoritetaan nyt seuraava käyttötapausskenaario selaimella.

GET Tutorial/Tutorialid – Kun asiakas kutsuu tätä Restful-rajapintaa, hänelle annetaan tutoriaalin nimi asiakkaan lähettämän Tutorialid:n perusteella.

Lisää selaimessasi merkkijono /1 Tutorial-sanan perään URLJos painat Enter-painiketta, saat alla olevan tulosteen.

Näet nyt tuloksena olevan ”Queues”-metodin, joka vastaa numeroa 1 tutoriaalimerkkijonojen luettelossamme. Tämä tarkoittaa, että verkkopalvelumme kutsuu nyt 'GetTutorialbyID'-metodia. Se osoittaa myös, että arvo 1 välitetään onnistuneesti selaimen kautta verkkopalveluumme ja metodiimme, ja siksi saamme selaimessa oikean vastaavan arvon ”Queues”-metodille.

2. Seuraavaksi käytetään verkkopalveluamme suorittamalla alla oleva skenaario. Tätä varten sinun on asennettava työkalu nimeltä Fiddler, joka on ilmainen ladattava työkalu.

POST Tutorial/Tutorialname – Kun asiakas kutsuu tätä Restful-rajapintaa, se lähettää pyynnön Tutorialname-nimen lisäämiseksi. Verkkopalvelu lisää sitten lähetetyn tutoriaalin nimen kokoelmaan.

Suorita Fiddler työkalu ja suorita alla olevat vaiheet.

1. Siirry kirjoitusosioon. Tätä käytetään pyyntöjen luomiseen, jotka voidaan lähettää mihin tahansa verkkosovellukseen.
2. Varmista, että pyynnön tyyppi on ”POST” ja että se on oikein. URL on iskun kohteena, mikä meidän tapauksessamme pitäisi olla http://localhost:52645/TutorialService.svc/Tutorial.
3. Varmista, että Content-Type on merkitty application/json. Muista, että verkkopalvelumme POST-pyyntömetodi hyväksyy vain JSON-tyylistä dataa, joten meidän on varmistettava, että tämä määritetään, kun lähetämme pyynnön sovelluksellemme.
4. Lopuksi meidän on syötettävä tietomme. Muista, että POST-metodimme hyväksyy parametrin nimeltä 'str'. Tässä siis määritämme, että haluamme lisätä arvon nimeltä "Puut" tutoriaalien nimien kokoelmaamme ja varmistaa, että se on tagattu 'str'-muuttujanimellä.

Lopuksi napsauta vain Suorita-painiketta kohdassa FiddlerTämä lähettää verkkopalvelulle pyynnön lähettää "Puut"-data verkkopalveluumme.

Kun nyt selaamme Tutoriaalia URL Jos haluat näyttää kaikki tutoriaalilistamme merkkijonot, huomaat, että myös "Trees"-arvo on läsnä. Tämä osoittaa, että verkkopalvelulle lähetetty POST-pyyntö suoritettiin onnistuneesti ja että se lisättiin onnistuneesti tutoriaalilistaamme.

3. Seuraavaksi käytetään verkkopalveluamme suorittamalla alla oleva skenaario. Tätä varten meidän on käytettävä myös Fiddler työkalu.

POISTA Tutorial/Tutorialid – Kun asiakas käynnistää tämän Restful-rajapinnan, se lähettää pyynnön Tutorialid:hen perustuvan Tutorialname-nimen poistamiseksi. Verkkopalvelu poistaa sitten lähetetyn tutoriaalin nimen kokoelmasta.

Suorita Fiddler työkalu ja suorita alla olevat vaiheet.

1. Siirry kirjoitusosioon. Tätä käytetään pyyntöjen luomiseen, jotka voidaan lähettää mihin tahansa verkkosovellukseen.
2. Varmista, että pyynnön tyyppi on ”POISTA” ja että se on oikein. URL on iskun kohteena, mikä meidän tapauksessamme pitäisi olla http://localhost:52645/TutorialService.svc/TutorialVarmista, että merkkijonon poistamiseen luettelosta käytetty tunnus lähetetään . URL parametrina. REST-esimerkissämme lähetämme arvon 1, joten tämä poistaa arvon 2^nd kokoelmamme elementti, joka on ”Jonot”.

Lopuksi napsauta vain Suorita-painiketta kohdassa FiddlerTämä lähettää verkkopalvelulle pyynnön POISTAA datajonot verkkopalvelustamme.

Kun nyt selaamme Tutoriaalia URL Jos haluat näyttää kaikki tutoriaaliluettelomme merkkijonot, huomaat, että ”Jonot”-arvoa ei enää ole.

Tämä osoittaa, että verkkopalvelulle lähetetty DELETE-pyyntö suoritettiin onnistuneesti. Tutoriaalimerkkijonojen luettelossamme indeksin 1 mukainen elementti poistettiin onnistuneesti.

RESTful-rajapinnan parhaat käytännöt

Toimivan REST-rajapinnan rakentaminen on vasta ensimmäinen askel; skaalautuvan ja ylläpidettävän REST-rajapinnan rakentaminen vaatii kurinalaisuutta. Alla olevat käytännöt auttavat pitämään päätepisteesi ennustettavina, turvallisina ja helppokäyttöisinä muille kehittäjille ja tekoälyagenteille.

• Käytä substantiiveja, älä verbejä URLs. Päätepisteet, kuten /työntekijät/1 ovat selkeämpiä kuin /getTyöntekijä?id=1, koska HTTP-verbi kuvaa jo toiminnon.
• Palauta merkitykselliset tilakoodit. Lähetä 200 onnistumisesta, 201 luodusta resurssista, 400 virheellisestä pyynnöstä, 401 luvattomasta käytöstä, 404 puuttuvasta resurssista ja 500 palvelinvirheistä.
• Versioi API:si. Versiosegmentin lisääminen, kuten /v1/ polussa voit kehittää palvelua katkaisematta olemassa olevien asiakkaiden toimintaa.
• Suojaa jokainen päätepiste. Käytä HTTPS:ää yhdessä API-avainten tai OAuth 2.0 -tokenien kanssa ja vahvista kaikki saapuva syöte.
• Tuki sivutukselle ja suodatukselle. Suurten kokoelmien palauttaminen sivuilla pitää vastaukset nopeina ja vähentää palvelimen kuormitusta.

Näiden käytäntöjen noudattaminen tekee RESTful-verkkopalvelustasi intuitiivisen integroitavan, olipa kyseessä sitten mobiilisovellus, kumppanijärjestelmä tai automatisoitu tekoälytyönkulku.

UKK