API-kehitys

Rakenna, testaa ja julkaise rajapintoja käyttämällä nykyaikaisia jakeluputkia ja parhaita teknisiä käytäntöjä.

Tulokset

• Rajapinnat, jotka on toteutettu testattujen kehysten ja mallien avulla.

Liittyvät metrolinjat

• API-suunnittelulinja
• Toimituslinja

Miksi sillä on merkitystä

Parhaatkin API-suunnitelmat epäonnistuvat, jos kehitys on epäjohdonmukaista. Tällä asemalla varmistetaan, että rajapinnat rakennetaan laadukkaasti, testataan perusteellisesti ja otetaan käyttöön luotettavasti, mikä mahdollistaa nopeammat iteraatiot ja suuremman luottamuksen.

Pääsykriteerit

• API-arkkitehtuuri käyttää uudelleenkäytettävyyttä ja integrointia edistäviä malleja, ja se on vahvistettu sidosryhmien kanssa.
• APIn tavoitteena on piilottaa taustalla olevat tietomallit ja eroavaisuudet.
• APIn suunnittelu ja päätepisteet ovat selkeästi yhteydessä niiden liiketoiminnalliseen arvoon ja ominaisuuksiin.
• APIn suunnittelu on yhdenmukainen muiden API-tuotteidemme kanssa.

Poistumiskriteerit

• API-arkkitehtuuri käyttää uudelleenkäytettävyyttä ja integrointia edistäviä malleja, ja se on vahvistettu sidosryhmien kanssa.
• APIn suunnittelu ja päätepisteet ovat selkeästi yhteydessä niiden liiketoiminnalliseen arvoon ja ominaisuuksiin.
• APIlla ja sen päätepisteillä on kuvaukset, jotka selittävät niiden liiketoiminnallisen arvon ja ominaisuudet.
• APIn suunnittelu on yhdenmukainen muiden API-tuotteidemme kanssa.
• API-sopimus on testattu ja se täyttää toiminnalliset ja ei-toiminnalliset vaatimukset.

Näin se toimii

1. Käytetään vakiintuneita kehyksiä ja kirjastoja sovellusliittymien toteuttamiseen ja varmistetaan, että ne ovat uudelleenkäytettäviä ja ylläpidettäviä.
   API-kehityksen parhaat käytännöt Ohjeet, joilla edistetään johdonmukaisia, ylläpidettäviä API-koodipohjia käyttämällä standardikirjastoja, uudelleenkäytettäviä malleja ja yhdenmukaistettuja kehitystyönkulkuja.
2. Sovellat sopimuslähtöisiä tai suunnittelulähtöisiä lähestymistapoja varmistaaksesi, että API-sopimukset validoidaan ennen toteutusta.
   Sopimus First Design Suuntaviiva, jossa kannatetaan API-lähestymistapaa, jossa käytetään virallisia sopimuksia (esim. OpenAPI) sidosryhmien yhdenmukaistamiseksi ennen kehitystä.
3. Testaa rajapintojen toimivuutta, turvallisuutta ja suorituskykyä automaattisten testausvälineiden avulla.
   API-testauksen parhaat käytännöt Ohjeet automatisoidun toiminnallisen, suorituskyky- ja tietoturvatestauksen toteuttamiseksi koko sovellusrajapinnan elinkaaren ajan.
4. Käytetään CI/CD-putkia rakentamis-, testaus- ja käyttöönottoprosessien automatisoimiseksi varmistaen johdonmukaisen laadun ja jäljitettävyyden.
   APIOps CI/CD sovellusrajapinnoille Käyttöönotto-ohjeet, jotka integroivat APIn elinkaaren tehtävät - suunnittelun, testauksen ja hallinnan - jatkuvaan integrointiin ja toimitusputkiin.
5. Varmistetaan, että rajapinnat täyttävät turvallisuus- ja vaatimustenmukaisuusvaatimukset automaattisten tarkastusten ja auditointien avulla.
   API-turvallisuuden parhaat käytännöt Joukko toimivia valvontatoimia sovellusrajapintojen suojaamiseksi, mukaan lukien todennus, valtuutus, salaus, nopeuden rajoittaminen ja putkitason vaatimustenmukaisuustarkastukset.
6. Varmistetaan API-auditoinnin tarkistuslistan avulla, että API täyttää toiminnalliset ja muut kuin toiminnalliset vaatimukset, mukaan lukien tietoturva, suorituskyky ja vaatimustenmukaisuus.
   API-auditoinnin tarkistuslista Kattava tarkistuslista API-valmiuden tarkistamiseksi ennen julkaisemista, joka kattaa suunnittelun, dokumentoinnin, tietoturvan ja käytäntöjen noudattamisen.

Sovella työssäsi

Toimittaa koodauskehyksiä, kirjastoja ja standardeja API-toteutusta varten. CI/CD-putkien, laadunvarmistuskehysten ja käyttöönottoautomaatiotyökalujen toteuttaminen.