graphene/docs/types/interfaces.rst

62 lines
1.4 KiB
ReStructuredText
Raw Normal View History

Interfaces
==========
An Interface contains the essential fields that will be implemented among
multiple ObjectTypes.
The basics:
2016-09-21 11:16:35 +03:00
- Each Interface is a Python class that inherits from ``graphene.Interface``.
- Each attribute of the Interface represents a GraphQL field.
Quick example
-------------
This example model defines a Character, which has a name. ``Human`` and
``Droid`` are two of the Interface implementations.
.. code:: python
import graphene
class Character(graphene.Interface):
name = graphene.String()
# Human is a Character implementation
class Human(ObjectType):
class Meta:
interfaces = (Character, )
born_in = graphene.String()
# Droid is a Character implementation
class Droid(Character):
class Meta:
interfaces = (Character, )
function = graphene.String()
**name** is a field in the ``Character`` interface that will be in both
``Human`` and ``Droid`` ObjectTypes (as those implement the ``Character``
interface). Each ObjectType also define extra fields at the same
time.
The above types would have the following representation in a schema:
2016-09-25 15:01:12 +03:00
.. code::
interface Character {
name: String
}
type Droid implements Character {
name: String
function: String
}
type Human implements Character {
name: String
bornIn: String
}