Päivitys lähteestä
API-määritys elää. Uudelleentuonti kaiken ylikirjoittaen hukkaisi säätösi; uudelleentuonti viereen tuottaisi kaksoiskappaleen. Restorm tekee kolmannen asian: se laskee erotuksen.
Miten se toimii
Section titled “Miten se toimii”Jokainen onnistunut tuonti tallentaa lähteen tiivisteen luotuun muuttujakansioon. Kansion Päivitä-painike hakee lähteen, vertaa tiivisteitä ja soveltaa erot sen sijaan, että aloittaisi alusta:
- uudet operaatiot lisätään siihen kohtaan, johon uusi tuonti olisi ne sijoittanut;
- muuttuneiden operaatioiden parametrit täydennetään sillä, mitä määritys lisää;
- määrityksen vanhentuneiksi merkitsemät operaatiot merkitään ja näkyvät puussa himmennettyinä;
- lähteestä kadonneet operaatiot merkitään poistetuiksi ja näkyvät yliviivattuina — ne pysyvät suoritettavina eikä niitä koskaan poisteta;
- muutoksesi säilyvät: nimeä, metodia, URL-osoitetta ja syötettyjä arvoja ei koskaan ylikirjoiteta.
Periaate: määritys on auktoriteetti sen suhteen, mitä se kuvaa, ja sinä olet auktoriteetti muun suhteen.
Koko kulku — missä painike on, mitä ohjattu toiminto näyttää ennen soveltamista ja mitä dokumentaatiolle tapahtuu — on kuvattu sivulla Tuodun API:n dokumentaation käyttö ja päivitys.
Uudelleen synkronoitavat muodot
Section titled “Uudelleen synkronoitavat muodot”Kaksitoista muotoa kuuluu tähän joukkoon:
- OpenAPI 3.x
- Swagger 2.0 (sama sivu kuin edellisellä, mutta laskettu tässä erikseen: molemmilla on oma uudelleensynkronoinnin logiikkansa)
- GraphQL (SDL)
- gRPC —
.proto-tiedosto ja palvelinreflektio - SOAP / WSDL
- OData
- AsyncAPI
- Postman
- Insomnia
- Bruno
- OpenRPC
- Smithy
Muodot, joita ei voi synkronoida uudelleen
Section titled “Muodot, joita ei voi synkronoida uudelleen”HAR, cURL, PowerShell, REST Client, Thunder Client, Paw, HTTPie, RAML, WADL, Thrift, TypeSpec, API Blueprint, tRPC.
Näiden kohdalla uusi tuonti luo uuden puun: sinun tehtäväksesi jää yhdistää nämä kaksi tai tuoda omaan kansioonsa.
Erikoistapaus: gRPC reflektiolla
Section titled “Erikoistapaus: gRPC reflektiolla”Reflektiolla tuodussa gRPC-pyynnössä on painike Päivitä reflektiosta suoraan sen välilehdellä: se on lyhin reitti, kun palvelu kehittyy kesken kehitystyön.