Verkkopalvelun Web Services -rajapinnan kuvaaminen ja toteutus
Vatanen, Matias (2011)
2011
All rights reserved. This publication is copyrighted. You may download, display and print it for Your own personal use. Commercial use is prohibited.
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-2023092626359
https://urn.fi/URN:NBN:fi:amk-2023092626359
Tiivistelmä
Tämän opinnnäytetyön aiheena on REST-tyyppisen Web Services API:n toteuttaminen CakePHP-sovelluskehyksellä. CakePHP:n avulla ohjelmoidaan Web Services -rajapinta toimeksiantajayrityksen web-sovelluksen hakutoimintojen käyttämiseen.
Opinnäytetyön tietoperustassa kerrotaan ensin Web Services -teknologioista, joista keskitytään eniten REST:iin. Siitä kuvataan ensin sen akateeminen määritelmä ohjelmistoarkkitehtuurimallina tietoverkkopohjaisten järjestelmien suunnitteluun. Toiseksi kerrotaan mitä REST:illä useimmiten käytännössä tarkoitetaan Web Services -teknologioista puhuttaessa. Tämän jälkeen keskitytään MVC-sunnittelumallin (Model – View – Controller, Malli – Näkymä – Ohjain) ja CakePHP-sovelluskehyksen kuvaamiseen.
Opinnäytetyön tuloksena on tehty REST-tyyppinen Web Services API CakePHP:llä ja kuvattu sen toteutusta sekä suunnittelussa käytettyjä ratkaisuja, kuten virhetilanteiden ja parametrien käsittelyn toteuttamista. Lisäksi opinnäytetyössä kuvataan yleisesti perusperiaatteita REST-tyyppisen Web Services API:n toteuttamisesta CakePHP:llä. The subject of this thesis is how to implement a REST based Web Services API using CakePHP framework. CakePHP framework is used in programming a REST based interface for using some search features of the application which was developed during the thesis project.
The knowledge base for this thesis consits of Web Services technologies, in particular REST, MVC design pattern and CakePHP framework. REST is described in two ways, first as an academically specified software architectural model for creating network based systems. What REST is in practice when spoken about Web Services technologies is also explained. After that MVC (Model - View – Controller) design pattern and CakePHP framework are described.
The main result of this thesis was a REST based Web Services API implemented with CakePHP. How it was implemented and what kind of design practices were chosen when programming it is explained.
Opinnäytetyön tietoperustassa kerrotaan ensin Web Services -teknologioista, joista keskitytään eniten REST:iin. Siitä kuvataan ensin sen akateeminen määritelmä ohjelmistoarkkitehtuurimallina tietoverkkopohjaisten järjestelmien suunnitteluun. Toiseksi kerrotaan mitä REST:illä useimmiten käytännössä tarkoitetaan Web Services -teknologioista puhuttaessa. Tämän jälkeen keskitytään MVC-sunnittelumallin (Model – View – Controller, Malli – Näkymä – Ohjain) ja CakePHP-sovelluskehyksen kuvaamiseen.
Opinnäytetyön tuloksena on tehty REST-tyyppinen Web Services API CakePHP:llä ja kuvattu sen toteutusta sekä suunnittelussa käytettyjä ratkaisuja, kuten virhetilanteiden ja parametrien käsittelyn toteuttamista. Lisäksi opinnäytetyössä kuvataan yleisesti perusperiaatteita REST-tyyppisen Web Services API:n toteuttamisesta CakePHP:llä.
The knowledge base for this thesis consits of Web Services technologies, in particular REST, MVC design pattern and CakePHP framework. REST is described in two ways, first as an academically specified software architectural model for creating network based systems. What REST is in practice when spoken about Web Services technologies is also explained. After that MVC (Model - View – Controller) design pattern and CakePHP framework are described.
The main result of this thesis was a REST based Web Services API implemented with CakePHP. How it was implemented and what kind of design practices were chosen when programming it is explained.