GraphQL API

Definindo o Esquema da Classe (Schema Class)

Um plugin pode extender a API do GraphQL do NetBox registrando sua própria classe de esquema (schema class). Por padrão, NetBox irá tentar importar o graphql.schena do plugin, se existir. O caminho pode ser sobreposto definindo o graphql_schema na instância de PluginConfig como uma caminho pontilhado (dotted path) para a classe desejada do Python. Essa classe deve ser uma subclasse de graphene.ObjectType. A plugin can extend NetBox's GraphQL API by registering its own schema class. By default, NetBox will attempt to import graphql.schema from the plugin, if it exists. This path can be overridden by defining graphql_schema on the PluginConfig instance as the dotted path to the desired Python class. This class must be a subclass of graphene.ObjectType.

Exemplo

# graphql.py
import graphene
from netbox.graphql.types import NetBoxObjectType
from netbox.graphql.fields import ObjectField, ObjectListField
from . import filtersets, models

class MyModelType(NetBoxObjectType):

    class Meta:
        model = models.MyModel
        fields = '__all__'
        filterset_class = filtersets.MyModelFilterSet

class MyQuery(graphene.ObjectType):
    mymodel = ObjectField(MyModelType)
    mymodel_list = ObjectListField(MyModelType)

schema = MyQuery

Objetos GraphQL

O NetBox fornece dois tipos de classes de objeto para serem utilizadas pelos plugins:

::: netbox.graphql.types.BaseObjectType options: members: false

::: netbox.graphql.types.NetBoxObjectType options: members: false

Campos GraphQL

O NetBox fornece duas classes de campos para serem utilizadas pelos plugins:

::: netbox.graphql.fields.ObjectField options: members: false

::: netbox.graphql.fields.ObjectListField options: members: false