Siirry sisältöön

Sopimus First Design

Suuntaviiva, jossa kannatetaan API-lähestymistapaa, jossa käytetään virallisia sopimuksia (esim. OpenAPI) sidosryhmien yhdenmukaistamiseksi ennen kehitystä.

  • Parempi ymmärrys sopimuksen suunnitteluperiaatteista
  1. Sovellat sopimuslähtöisiä tai suunnittelulähtöisiä lähestymistapoja varmistaaksesi, että API-sopimukset validoidaan ennen toteutusta.
  2. Määrittele API-sopimukset, joissa hahmotellaan kunkin APIn odotukset, vastuut ja käyttöohjeet.
  3. Käytä standardoituja formaatteja (esim. OpenAPI, AsyncAPI) luodaksesi koneellisesti luettavia API-sopimuksia, joita on helppo jakaa ja validoida.