U bent hier: home » blog

      Good​ ​practices​ ​bij​ ​het​ ​maken​ ​van​ ​een webservice

      Bij het ontwikkelen van een webservice is het aangewezen een aantal vuistregels in acht te houden om het voor jezelf als voor de partij die de webservice zal consumeren duidelijk en leuk te houden. Daarom enkele puntjes die je kunnen helpen om tot een efficiënte oplossing te komen.

       

      Schaalbaarheid

      Zorg ervoor dat de webservice makkelijk uitgebreid kan worden met extra functionaliteiten. Bouw deze zo modulair mogelijk met het oog op eventueel toekomstige uitbreidingen.


      Documenteer

      Zorg ervoor dat je naast het WSDL-document ook een korte samenvattende tekst hebt waarin de methods beschreven worden. Maak een duidelijk overzicht van de parameters die verwacht worden, en de parameters die teruggestuurd worden bij elke method. Vermijd hiermee support telefoontjes of mails.


      Veiligheid

      Zorg ervoor dat er een authenticatie aan elke request voorafgaat. Gaat het om een webservice tussen twee of meer gekende partijen, configureer dan zeker de firewall zodat enkel de gekende IP-adressen toegang krijgen.


      Beperk het aantal methods

      Zorg ervoor dat de mogelijkheden van de webservice overzichtelijk blijven. Dit kan je mede door het aantal methods te beperken. Maak de methods vrij breed zodat je niet voor elk klein stukje informatie een nieuwe method moet schrijven. Houd er rekening mee dat uw webservice makkelijk in gebruik is.


      Inputcontrole en volgorde van parameters

      Bouw inputcontrole in voor de verwachte parameters (verplicht, datatype, lengte,...). Houd ook een logische volgorde aan bij de inkomende en uitgaande parameters.


      Naamconventie

      Gebruik een logische en eenduidige naam voor de methods en de parameters. Ga ervan uit dat de andere partij die uw webservice consumeert in één oogopslag moet begrijpen waarover de de method of parameter gaat. Zorg ervoor dat de webservice voorspelbaar is.


      Foutbehandeling

      Zorg ervoor dat de webservice robuust is en niet stopt bij het verkeerd aanspreken van een method of het verkeerd doorgeven van een parameter. Zorg ook voor duidelijke feedback in de foutboodschappen van uw service.


      Heartbeat Method

      Dit is een method die geen functionele acties uitvoert. Deze method wordt enkel gebruikt om te controleren of een webservice bereikbaar en online is. Je kan hier eventueel wat basisinformatie terugsturen. Voor deze method is geen authenticatie nodig.

      webservices

      Als je deze eenvoudige vuistregels opvolgt en standaardiseert binnen uw organisatie, dan zal de communicatie tussen ontwikkelaar en consument van de web service vlotter verlopen. En dat tegen minimale inspanning.

      5 december 2017 - Redney Neve, webontwikkelaar
      Tags :technologie