Jaa

Kankaan ohjelmointirajapinta GraphQL-skeemanäkymälle ja skeemojen hallintaan

GraphQL Schema Definition Language (SDL) -kieleen perustuva GraphQL-skeema määrittää API:ssa paljastettujen tietojen muodon. Se tarjoaa joustavuutta kuluttajille ja piilottaa taustan toteutustiedot. Rakenne käyttää kokoelmaa objektityyppejä, jotka sisältävät kenttiä.

Rakennenäkymä

Siirry rakennenäkymään valitsemalla Rakenne Tietojen kehittäminen -näytön vasemmasta alakulmasta. Tässä näkymässä näkyy GraphQL SDL:n tekstipohjainen versio, jossa on luodut tyypit, kentät ja toiminnot.

Seuraavassa kuvassa on esimerkki rakennenäkymästä, mukaan lukien luettelo tässä rakenteessa käytettävissä olevista objekteista.

Muistiinpano

Rakennenäkymä on vain luku -tilassa. Muokkaa objekteja vain Schema Explorerissa.

Näyttökuva ohjelmointirajapinnan rakennenäkymänäytöstä, joka sisältää rakenteen hallinnan vasemmassa ruudussa.

Rakenteen hallinta

Rakenteen hallinta sijaitsee vasemmalla olevassa ruudussa, ja se on käytettävissä myös, kun käytät editoria kyselynäkymässä. Resurssienhallinnan avulla käyttäjät voivat nopeasti visualisoida ohjelmointirajapinnassa määritettyjä käytettävissä olevia tyyppejä ja kenttiä sekä kyselyitä ja mutaatioita.

Kaikki GraphQL-tyypit, jotka ovat käytettävissä valitsemistasi objekteista, kun muodostat yhteyden tietolähteeseen, näkyvät Rakenteen hallinta -luettelossa. Tyypit näkyvät sen tietolähteen nimen alla, josta ne johdettiin. Seuraavassa kuvassa näkyy SalesOrderDetail-tyyppi, joka on johdettu AdventureWorksin SQL-analytiikan päätepisteen SalesOrderDetail-taulukosta.

Näyttökuva Rakenteen hallinta -ruudusta, jossa näkyy laajennettu luettelo SalesOrderDetail-nimisessä esimerkkitietolähteessä käytettävissä olevista tyypeistä.

Tyyppien lisäksi GraphQL:n Fabric-ohjelmointirajapinta luo automaattisesti kyselyitä ja mutaatioita uusille objekteille, jotka päätät paljastaa.

AdventureWorks-esimerkissä kyselyluettelon laajentaminen näyttää tietolähteelle automaattisesti luodut kyselyt.

Näyttökuva Rakenteen hallinta -ruudusta, jossa näkyy laajennettu luettelo automaattisesti luoduista kyselyistä.

Laajenna Schema Explorer -puun mutaatiosolmu, niin näet ohjelmointirajapinnan automaattisesti luomat mutaatiot.

Näyttökuva Rakenteen hallinta -ruudusta, jossa näkyy laajennettu luettelo automaattisesti luoduista mutaatioista.

Objektien muokkaaminen rakenteen hallinnan avulla

Schema Explorerin avulla voit muokata objekteja sen jälkeen, kun ohjelmointirajapinta on luonut ne puolestasi. Seuraavassa esimerkissä valitaan kolme pistettä AdventureWorks-tietokannasta johdettujen SalesOrderDetail-tyyppien vierestä:

Näyttökuva rakenteen hallinnasta, jossa kolme pistettä on valittuna ja jossa näkyvät käytettävissä olevat valikkovaihtoehdot.

Tyypit-kohdassa on käytettävissä seuraavat asetukset:

  • Päivitä rakenne – Voit päivittää rakenteen uusilla objekteilla tietolähteestä.

  • Nimeä uudelleen : tämä muuttaa objektin nimeä. Tämä muutos vaikuttaa vain ohjelmointirajapinnan rakenteeseen, eikä se vaikuta alkuperäiseen tietolähdeobjektiin, josta se on johdettu.

  • Poista rakenteesta – Poistaa objektin GraphQL-rakenteesta, joten et voi enää viitata siihen.

  • Suhteiden hallinta – Avaa suhteiden hallintakokemuksen. Lisätietoja on artikkelissa Suhteiden hallinta Fabric-ohjelmointirajapinnassa GraphQL:lle.

  • Ominaisuudet – Näyttää lisätietoja objektista.

Kyselyjen ja mutaatioiden ottaminen käyttöön ja poistaminen käytöstä

Kyselyiden ja mutaatioiden Ota käyttöön tai poista käytöstä -ominaisuus antaa järjestelmänvalvojille ja kehittäjille yksityiskohtaisen hallinnan ohjelmointirajapinnan käyttöön ja käyttöön. Sen avulla voit aktivoida tai poistaa tiettyjen kyselyjen ja mutaatioiden aktivoinnin tai deaktivoinnin GraphQL-rakenteessa. Tämän avulla voit hallita ohjelmointirajapinnan ominaisuuksia dynaamisesti muokkaamatta koodia tai ottamalla käyttöön muutoksia.

Skemanhallinnan kyselyillä ja mutaatioilla on kaksi muuta vaihtoehtoa:

  • Poista käytöstä: Estää pyyntöjä suorittamasta kyselyä tai mutaatiota. Jos suoritusta yritetään, palautetaan virhe. Kun kysely tai mutaatio on poistettu käytöstä, rakenne ladataan uudelleen ja kysely tai mutaatio näkyy harmaana rakenteen hallinnassa.

Näyttökuva kyselyn tai mutaation käytöstä poistamisesta -vaihtoehdosta, joka näkyy rakenteen hallinnassa.

  • Ota käyttöön: Voit ottaa aiemmin käytöstä poistetun kyselyn tai mutaation uudelleen käyttöön. Kysely tai mutaatio on heti käytettävissä rakenteen uudelleenlataustoiminnon jälkeen, joka tapahtuu, kun valitset Ota käyttöön -vaihtoehdon.

Näyttökuva Rakenteen hallinnassa näkyvästä mutaatiokyselyn käyttöönottovaihtoehdosta.

Tallennetuista proseduureista automaattisesti luodut kyselyt tai mutaatiot voidaan vain poistaa. Poistamisen jälkeen ne voidaan lisätä uudelleen Nouda tiedot - tai Päivitä rakenne -asetuksilla.

Liittyvä sisältö

  • Last updated on