Leum gu prìomh susbaint

A’ Cleachdadh an Legalesign GraphiQL Explorer

Leigidh am Legalesign GraphQL Explorer leat deuchainn a dhèanamh air ceistean agus gluasadan an aghaidh an API beò, sgrùdadh a dhèanamh air a’ chuibhreann iomlan, agus dèiligeadh ri teachdaireachdan mearachd mus sgrìobhas tu còd.

Fosgail an Explorer

Rach gu https://graphiql.legalesign.com/ agus log a-steach leis na teisteanasan agad.

Sgrion Fosglaidh GraphiQL

nota

Ma chan eil cunntas Legalesign agad fhathast, clàraich airson deuchainn an-asgaidh.

Cruthaich Ceist

Paste am fear a leanas dhan phrìomh uinneag cheiste:

query MyFirstQuery {
user {
id
name
}
}

Bho chiall dùthchasach, ma ghlaodas tu air an nì user is iad an fhiosrachadh a thèid a thoirt air ais agad fhèin. Cuir a’ cheist an gnìomh le bhith a’ briogadh air a’ phutan cluich anns a’ bhàr-inneal àrd.

A’ Tuigsinn toraidhean

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

Tha am freagairt a’ toirt a-steach seilbh data le nì user — oir dh’iarr sinn air nì aon User.

fiosrachadh

Tha User na chùis shònraichte — mura toir thu seachad id, bidh e a’ gabhail gur e do fhiosrachadh fhèin a tha thu ag iarraidh. Le seòrsaichean nithean eile feumaidh tu an-còmhnaidh am id sònraichte a thoirt seachad:

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

Mar a Nochdas Barrachd Fiosrachaidh

Le Lorg

Sa cheàrnaidh gu h-àrd air an làimh dheis, briog air < Docs gus a-steach a ruighinn air an paneal sgrìobhaidh. Sa bhogsa Search Schema, cuir User air a chlò. Briog air an toradh as àirde gus fhaicinn na raointean uile rim faighinn air an t-seòrsa User, le tuairisgeulan air gach fear.

Mion-fhiosrachadh schema User

Le Sgrùdadh

Ma chan eil fios agad dè an seòrsa a tha thu ag iarraidh, dèan sgrùdadh air a’ chuibhreann nas fheàrr. Sa Documentation Explorer, briog air < Back gus tilleadh chun freumh. Chì thu trì seòrsaichean freumha: Query, Mutation agus Subscription.

Briog air Query gus fhaicinn na seòrsaichean rim faighinn:

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).

Thoir fa-near gu bheil an tuairisgeul do User ag innse dhuinn gun urrainn dhuinn an cleachdaiche làithreach fhaighinn le bhith a’ fàgail id às. Briog air seòrsa sam bith airson sgrùdadh a dhèanamh air na raointean aige.

Atharraich a’ Cheist

Feuch cuir barrachd raointean ris:

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

Brùth cluich. Tha na toraidhean a-nis a’ toirt a-steach an raon ùr:

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

Tha seo a’ sealltainn gu bheil cothrom rianadair aig an cleachdaiche deuchainn — ma tha thu a’ cleachdadh cunntas deuchainn an-asgaidh, tha coltas gu bheil cothrom coltach agad cuideachd.

Export This Article

Save a copy of this page as PDF or plain text.