Rajapintojen doku­men­tointi ja auto­maat­tinen testaus

Autamme rajapintojen dokumen­toinnissa ja testauksen suunnit­telussa. Projektit toteutetaan vaiheittain.

Vaihe 1: Dokumentointi

• Kirjoitamme raja­pinnas­tanne OpenAPI-standardin mukaisen määrittelyn. Loppu­tuloksena saatte kone­luettavan määrittelyn raja­pinnas­tanne.
• Tuotamme rajapinnan OpenAPI-määrittelyn pohjalta HTML-muotoisen dokumen­taation.
• Toimitamme teille ohjeet kuinka saatte julkaistua dokumen­taation verkko­sivuna tai halutessanne voimme ylläpitää dokumen­taatiota verkko­sivuna teille.

Vaihe 2: Perustestaus

• Tuotamme kattavat perustestit raja­pinnallenne ja ohjeis­tuksen siitä, kuinka voitte itse ajaa testejä raja­pintaanne vasten.
• Perustesteillä varmistetaan että raja­pinnan vastaukset ovat OpenAPI-määrittelyn mukaisia:
  • HTTP-tilakoodien osalta, eli raja­pinta­kutsu joko onnistuu tai epä­onnistuu määrittelyn mukaisella koodilla.
  • Datan rakenteen osalta, esimerkiksi datasta löytyvät kaikki määritellyt kentät ja datassa ei ole kenttiä, joita ei löydy määrit­telystä.
• Lisäksi testataan, että autenti­kaatiota tarvitsevat rajapinta­kutsut sitä myös vaativat.

Vaihe 3: Toiminnallinen testaus

• Perustestauksen jälkeen teemme yhdessä kehittäjienne tai tuote­omistaji­enne kanssa moni­mutkai­sempia testi­tapauksia raja­pinnan toiminta­logiikan testaukseen.
• Näillä testeillä testataan rajapinta­kutsuihin liittyvää toiminta­logiikka, esimerkiksi:
  • Laskennallisten kenttien testausta.
  • Moni­mutkai­sempien toimintojen testausta, esim. jos raja­pinnassa on tietueen konver­tointi useammaksi muuksi tietueeksi. Tyypillinen esimerkki on Liidi-tietueen konvertointi Asiakkaaksi, Kontaktiksi ja Myynti­mahdol­lisuu­deksi.

Raportointi

• Tuotamme teille raportin testauksen tuloksista, mukaan lukien tiedot onnistuneista ja epä­onnistuneista testeistä.
• Laadimme teille toimenpide­suosituksen, jossa käsitellään epä­onnistuneet testit tarkemmin ja suositellaan niiden korjaamista.