While each Modus SDK offers similar capabilities, the APIs and usage may vary between languages.Modus GraphQL APIs documentation is available on the following pages:
- AssemblyScript GraphQL APIs
- Go GraphQL APIs(this page)
Import
To begin, import thegraphql
package from the SDK:
GraphQL APIs
The APIs in thegraphql
package are below, organized by category.
We’re constantly introducing new APIs through ongoing development with early
users. Please open an issue if
you have ideas on what would make Modus even more powerful for your next app!
Functions
Execute
Execute a GraphQL statement to call a query or apply mutation against a GraphQL endpoint.Type of object to use for the data returned from the query. This can be any
type, including a custom type defined in your project. It should match the shape
of the data returned from the GraphQL query.
Define custom types in the project’s source code. All types must be JSON
serializable. You can also use built-in types such as strings, numbers,
slices, and maps.
Name of the connection, as defined in the
manifest.
GraphQL statement containing the query or mutation operation to execute.
While it’s possible to directly include parameter values into your GraphQL
statement, it’s highly recommended to pass a variables map instead. This can
help to prevent against injection attacks and other security vulnerabilities.
Optional variables to include with the query.The key should be the name of the GraphQL variable. The value can be of any type
that’s JSON serializable, including strings, numbers, boolean values, slices,
maps, and custom structs.
Types
Response
Errors
or Data
is present, depending on the result of the query.
An slice of errors incurred as part of your GraphQL request, if any.Each error in the slice is an
ErrorResult
object. If there are
no errors, this field is nil
.The resulting data selected by the GraphQL operation.The data is a pointer to an object the type specified in the call to the
Execute
function. If data is absent due to errors, this field is nil
.ErrorResult
Description of the error incurred.
Path to the area of the GraphQL statement related to the error.Each item in the slice represents a segment of the path.
An slice of
CodeLocation
objects that point to the specific
location of the error in the GraphQL statement.CodeLocation
Line number within the GraphQL statement for the code.
Column number within the GraphQL statement for the code.