Rust API client for figma-api
This is the OpenAPI specification for the Figma REST API.
Note: we are releasing the OpenAPI specification as a beta given the large surface area and complexity of the REST API. If you notice any inaccuracies with the specification, please file an issue.
Overview
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 0.31.0
- Package version: 0.31.0
- Generator version: 7.13.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named figma-api
and add the following to Cargo.toml
under [dependencies]
:
figma-api = { path = "./figma-api" }
Documentation for API Endpoints
All URIs are relative to https://api.figma.com
Class | Method | HTTP request | Description |
---|---|---|---|
ComponentSetsApi | get_component_set | GET /v1/component_sets/{key} | Get component set |
ComponentSetsApi | get_file_component_sets | GET /v1/files/{file_key}/component_sets | Get file component sets |
ComponentsApi | get_component | GET /v1/components/{key} | Get component |
ComponentsApi | get_file_components | GET /v1/files/{file_key}/components | Get file components |
FilesApi | get_file | GET /v1/files/{file_key} | Get file JSON |
FilesApi | get_file_meta | GET /v1/files/{file_key}/meta | Get file metadata |
FilesApi | get_file_nodes | GET /v1/files/{file_key}/nodes | Get file JSON for specific nodes |
FilesApi | get_image_fills | GET /v1/files/{file_key}/images | Get image fills |
FilesApi | get_images | GET /v1/images/{file_key} | Render images of file nodes |
StylesApi | get_file_styles | GET /v1/files/{file_key}/styles | Get file styles |
StylesApi | get_style | GET /v1/styles/{key} | Get style |
Documentation For Models
- Action
- ActionOneOf
- AfterTimeoutTrigger
- ArcData
- BackgroundBlurEffect
- BaseBlurEffect
- BaseBlurEffectBoundVariables
- BaseNoiseEffect
- BasePaint
- BaseShadowEffect
- BaseShadowEffectBoundVariables
- BaseTypeStyle
- BlendMode
- BlurEffect
- BooleanOperationNode
- CanvasNode
- ColorStop
- ColorStopBoundVariables
- Comment
- CommentClientMeta
- CommentFragment
- Component
- ComponentNode
- ComponentPropertiesTrait
- ComponentProperty
- ComponentPropertyBoundVariables
- ComponentPropertyDefinition
- ComponentPropertyDefinitionDefaultValue
- ComponentPropertyType
- ComponentPropertyValue
- ComponentSet
- ComponentSetNode
- ConditionalAction
- ConditionalBlock
- ConnectorEndpoint
- ConnectorEndpointOneOf
- ConnectorEndpointOneOf1
- ConnectorLineType
- ConnectorNode
- ConnectorTextBackground
- Constraint
- CornerRadiusShapeTraits
- CornerTrait
- DefaultShapeTraits
- DirectionalTransition
- DocumentNode
- DocumentationLink
- DropShadowEffect
- DuotoneNoiseEffect
- Easing
- EasingEasingFunctionCubicBezier
- EasingEasingFunctionSpring
- EasingType
- Effect
- EllipseNode
- EmbedNode
- ErrorResponsePayloadWithErrMessage
- ErrorResponsePayloadWithErrorBoolean
- ExportSetting
- Expression
- ExpressionFunction
- FlowStartingPoint
- FrameInfo
- FrameInfoContainingComponentSet
- FrameInfoContainingStateGroup
- FrameNode
- FrameOffset
- FrameOffsetRegion
- FrameTraits
- GradientPaint
- GroupNode
- HasBlendModeAndOpacityTrait
- HasChildrenTrait
- HasEffectsTrait
- HasExportSettingsTrait
- HasFramePropertiesTrait
- HasGeometryTrait
- HasLayoutTrait
- HasMaskTrait
- HasTextSublayerTrait
- Hyperlink
- ImageFilters
- ImagePaint
- IndividualStrokesTrait
- InlineObject
- InlineObject1
- InlineObject10
- InlineObject10Meta
- InlineObject11
- InlineObject11Meta
- InlineObject12
- InlineObject13
- InlineObject13Meta
- InlineObject14
- InlineObject14Meta
- InlineObject15
- InlineObject15Meta
- InlineObject16
- InlineObject17
- InlineObject18
- InlineObject19
- InlineObject1NodesValue
- InlineObject2
- InlineObject20
- InlineObject21
- InlineObject22
- InlineObject23
- InlineObject24
- InlineObject25
- InlineObject26
- InlineObject3
- InlineObject3Meta
- InlineObject4
- InlineObject5
- InlineObject6
- InlineObject6Meta
- InlineObject7
- InlineObject8
- InlineObject8Meta
- InlineObject9
- InlineObjectBranchesInner
- InnerShadowEffect
- InstanceNode
- InstanceSwapPreferredValue
- Interaction
- IsLayerTrait
- IsLayerTraitBoundVariables
- IsLayerTraitBoundVariablesIndividualStrokeWeights
- IsLayerTraitBoundVariablesRectangleCornerRadii
- IsLayerTraitBoundVariablesSize
- LayerBlurEffect
- LayoutConstraint
- LayoutGrid
- LayoutGridBoundVariables
- LibraryItemData
- LineNode
- LinkUnfurlNode
- LocalVariable
- LocalVariableCollection
- LocalVariableCollectionModesInner
- LocalVariableValuesByModeValue
- Measurement
- MeasurementOffset
- MeasurementOffsetInner
- MeasurementOffsetOuter
- MeasurementStartEnd
- MinimalFillsTrait
- MinimalStrokesTrait
- MonotoneNoiseEffect
- MultitoneNoiseEffect
- Navigation
- Node
- NodeAction
- NoiseEffect
- NormalBlurEffect
- OnKeyDownTrigger
- OnMediaHitTrigger
- OpenUrlAction
- Overrides
- Paint
- PaintOverride
- Path
- PatternPaint
- ProgressiveBlurEffect
- PrototypeDevice
- PublishedComponent
- PublishedComponentSet
- PublishedStyle
- PublishedVariable
- PublishedVariableCollection
- Reaction
- Rectangle
- RectangleNode
- RectangularShapeTraits
- Region
- RegularPolygonNode
- ResponseCursor
- ResponsePagination
- Rgb
- Rgba
- SectionNode
- SetVariableAction
- SetVariableModeAction
- ShapeType
- ShapeWithTextNode
- SimpleTransition
- Size
- SliceNode
- SolidPaint
- SolidPaintAllOfBoundVariables
- StarNode
- StickyNode
- StrokeWeights
- Style
- StyleType
- SubcanvasNode
- TableCellNode
- TableNode
- TextNode
- TextPathNode
- TextPathPropertiesTrait
- TextPathTypeStyle
- TextPathTypeStyleAllOfBoundVariables
- TextureEffect
- TransformGroupNode
- Transition
- TransitionSourceTrait
- Trigger
- TriggerOneOf
- TriggerOneOf1
- TriggerOneOf2
- TypePropertiesTrait
- TypeStyle
- TypeStyleAllOfBoundVariables
- UpdateMediaRuntimeAction
- UpdateMediaRuntimeActionOneOf
- UpdateMediaRuntimeActionOneOf1
- UpdateMediaRuntimeActionOneOf2
- User
- VariableAlias
- VariableChange
- VariableCodeSyntax
- VariableCollectionChange
- VariableCollectionCreate
- VariableCollectionDelete
- VariableCollectionUpdate
- VariableCreate
- VariableData
- VariableDataType
- VariableDataValue
- VariableDelete
- VariableModeChange
- VariableModeCreate
- VariableModeDelete
- VariableModeUpdate
- VariableModeValue
- VariableResolvedDataType
- VariableScope
- VariableUpdate
- VariableValue
- Vector
- VectorNode
- Version
- WashiTapeNode
- WidgetNode
To get access to the crate's generated documentation, use:
cargo doc --open