Siirry sisältöön
Restorm Restormin dokumentaatio

Ongelmien havaitseminen tuodussa API:ssa

Kun tuotte API:n (OpenAPI, Swagger ja muut tuetut muodot), Restorm säilyttää API:n jäsennellyn dokumentaation sen muuttujakansiossa. Heti tuonnin jälkeen — ja aina kun avaatte tiedoston uudelleen — Restorm projisoi tämän dokumentaation huomaamattomasti suunnitelmaksi ja suorittaa saman validoinnin kuin API-suunnittelija, kokonaan taustalla. Se ei koskaan estä tuontia eikä koskaan keskeytä sitä, mitä olette tekemässä.

Jos se ei löydä mitään, ette näe mitään. Jos se löytää rakenteellisia ongelmia, se osoittaa ne teille kahdessa paikassa.

”!” sivupalkissa

Section titled “”!” sivupalkissa”

Muuttujakansio, joka sisältää merkityn API:n, näyttää rivinsä oikeassa reunassa pienen ”!”-merkin. Se on yhdellä silmäyksellä näkyvä signaali, että tämän API:n suunnitelmassa on jotain katsomisen arvoista — ja se katoaa itsestään heti, kun API on jälleen puhdas (uudelleentuonnin tai sen korjaavan API-päivityksen jälkeen).

”Ongelmat”-välilehti

Section titled “”Ongelmat”-välilehti”

Avatkaa muuttujakansio, niin siihen ilmestyy ”Ongelmat”-välilehti. Välilehti tulee näkyviin vain, kun ongelmia havaittiin — puhdas API ei näytä sitä koskaan.

Tuodun API muuttujakansion ”Ongelmat”-välilehti: varoitushuomautus ja sen jälkeen ongelmat tyypeittäin ryhmiteltyinä — ”Useat reitit vastaavat samaan menetelmään ja polkuun”, ”Jotkin reitit eivät ilmoita mitään vastausta”, ”Jotkin reitit sijaitsevat polulla, jonka suunnittelupalvelin varaa” — kukin luettelee tarkat reitit, joihin se vaikuttaa, yksi laajennettuna näyttämään kyseisen reitin dokumentaation

Ongelmat ryhmitellään tyypeittäin, joten kaksikymmentä päällekkäistä reittiä näkyy yhtenä rivinä ja lukumääränä kahdenkymmenen erillisen merkinnän sijaan. Kunkin tyypin alla Restorm luettelee tarkat kyseessä olevat entiteetit — reitti näyttää HTTP-verbinsä ja todellisen polkunsa ja laajenee kyseisen reitin dokumentaatioksi, joten näette, mitä se ilmoittaa poistumatta välilehdeltä.

Tarkistukset vastaavat API-suunnittelijan tarkistuksia, joten näkemienne ongelmien tyyppejä voivat olla:

  • päällekkäiset reitit — kaksi reittiä, jotka vastaavat samaan menetelmään ja polkuun;
  • puuttuvat vastaukset — reitti, joka ei ilmoita lainkaan vastausta;
  • varatut polut — reitti, joka sijaitsee polulla, jonka Mock Server varaa (/swagger.json, /graphql, …) ja joka ei koskaan vastaisi;
  • rajoiteongelmat — virheellinen kuvio tai maksimiaan suurempi minimi.

Luettelo on vain luettavissa: se kertoo, mitä korjata, ja te korjaatte sen lähteessä (tuokaa korjattu määrittely uudelleen tai muokatkaa API:a). Se lasketaan uudelleen tapahtumissa, jotka muuttavat API:a — tiedoston avaus, tuonti, API-päivitys — ei jokaisella näppäinpainalluksella.