OpenAPI on web-pohjainen ohjelmistoarkkitehtuuri, joka nostaa tuotetiedon käytettävyyden uudelle tasolle. Se mahdollistaa ulkopuolisille ohjelmistokehittäjille tehokkaan ja standardin tavan rakentaa liityntöjä olemassaoleviin tietojärjestelmiin tai omia, kokonaan uusia applikaatioita, jotka reaaliaikaisesti hyödyntävät Vertex-tiedonhallintajärjestelmän monipuolista tietosisältöä. OpenAPI:n toteutus ja dokumentointi nojautuu OpenAPI 3.0 -standardin mukaiseen viitekehykseen ja sen kautta ohjelmistokehittäjä saa paitsi rajapinnan kuvaukset myös työkaluja omaan kehitystyöhönsä.

Rajapintakuvaukset (2021)

• https://documenter.getpostman.com/view/3502772/SztA8V9h

Uutta versiossa 2021

• OpenAPI virhetilanteiden käsittelyn parannukset (PDM-11042)
• OpenAPI:n avulla liitoksen teko (PDM-10775)
• OpenAPI:n avulla varatun nimikkeen osaluettelon haku (PDM-11110)
• OpenAPI, käyttäjätietojen haku (PDM-11187)
• OpenAPI ja task-tiedoston suorittaminen ja tilan kysely palvelimella (PDM-11080)
• OpenAPI/konfiguraattori, valintariippuvuuksien haku (PDM-11179)
• OpenAPI/konfiguraattori, valintarakenteen haku (PDM-11177)
• OpenAPI, tilojen käsittelyyn liittyvät toiminnot (PDM-11194)

Lisätietoja

• Postman API Client: https://www.getpostman.com/product/api-client
• OpenAPI Specification, Swagger: https://swagger.io/docs/specification/about/

Everything You Need to Know About OpenAPI 3.0

Developing APIs with OAS and Swagger Codegen

https://www.youtube.com/watch?v=rJQ-SVKxb5I