Defnyddio Archwilydd GraphiQL Legalesign

Mae’r Archwilydd GraphQL Legalesign yn eich galluogi i brofi ceisiadau a newidiadau yn erbyn yr API byw, pori’r cylchgrawn cyflawn, a datrys chwilod cyn ysgrifennu cod.

Agor yr Archwilydd

Ewch i https://graphiql.legalesign.com/ a mewngofnodi gyda’ch manylion mewngofnodi.

nodyn

Os nad oes gennych gyfrif Legalesign eto, cofrestrwch ar gyfer treial am ddim.

Creu Cais

Gludwch y canlynol i ffenestr y cais prif:

query MyFirstQuery {
  user {
    id
    name
  }
}

Yn ddiofyn, os galwch y gwrthrych user, y wybodaeth a dderbynnir yw eich un chi eich hun. Gweithredwch y cais drwy glicio’r botwm chwarae yn y bar offer uchaf.

Deall Canlyniadau

{
  "data": {
    "user": {
      "id": "dXNyZTE2NBB1NWQtNWVjXS00NzIzL3G3NDI5ODEtZmFhOGFjYzdlMGRh",
      "name": "Bob Mortimer",
      "firstName": "Bob",
      "lastName": "Mortimer"
    }
  }
}

Mae’r ymateb yn cynnwys eiddo data gyda gwrthrych user — oherwydd gofynnwyd am un gwrthrych User.

gwybodaeth

Mae User yn achos arbennig — os na roddwch id, mae’n tybio eich bod eisiau eich gwybodaeth user eich hun. Gyda mathau eraill o wrthrychau bydd angen i chi bob amser basio’r id penodol:

query GetAGroup {
  group(id: 'zSJy2jhsdDF') {
    id
    name
  }
}

Sut i Ddysgu Mwy

Drwy Chwilio

Yn y gornel dde uchaf, cliciwch < Docs i agor y panel dogfennaeth. Yn y blwch Search Schema, teipiwch User. Cliciwch y canlyniad uchaf i weld yr holl faes sydd ar gael ar y math User, gyda disgrifiadau ar gyfer pob un.

Drwy Borïo

Os nad ydych yn gwybod pa fath rydych ei eisiau, porwch y cylchgrawn yn lle hynny. Yn y Documentation Explorer, cliciwch < Back nes bod chi yn y gwraidd. Fe welwch dri math gwraidd: Query, Mutation a Subscription.

Cliciwch Query i weld y mathau sydd ar gael:

organisation(id: ID, orgId: ID): Organisation
Returns an Organisation.

group(id: ID, groupId: ID): Group
Returns a Group.

user(id: ID, userId: ID): User
Returns a User (or the current user if id is null).

Sylwch fod y disgrifiad ar gyfer User yn dweud wrthym y gallwn gael yr user cyfredol drwy hepgor id. Cliciwch unrhyw fath i archwilio ei faesau.

Newid y Cais

Rhowch gynnig ar ychwanegu mwy o faesau:

query MyFirstQuery {
  myInfo: user {
    id
    name
    canAdministerUsers
  }
}

Gwasgwch chwarae. Mae’r canlyniadau bellach yn cynnwys y maes newydd:

{
  "data": {
    "myInfo": {
      "id": "...",
      "name": "...",
      "canAdministerUsers": true
    }
  }
}

Mae hyn yn dangos bod gan yr user prawf fynediad gweinyddol — os ydych yn defnyddio cyfrif treial am ddim, mae’n debyg bod gennych chi hefyd.