الوصف
[Documentation]
BluAPI - API Contracts made Easy
BluAPI makes it easier for designers to use API endpoints inside their Unreal Engine projects without having to handle C++ implementation details.
Define reusable parts of an API request directly within the editor: base URLs, endpoints, and named bindings between them. Use those bindings in your Blueprints to send asynchronous HTTP requests and handle their responses. The plugin also supports JWT (JSON Web Token) authentication and OAuth2 authentication flows (experimental) for establishing authenticated sessions.
BluAPI makes use of Unreal Engine’s user-defined structures to describe your API contracts. Assign a request body structure and choose a supported encoding, and the plugin handles serialization under the hood. For JSON responses, define the expected structure and BluAPI deserializes the response into it for use in your Blueprints.
The structure management interface helps you organize and inspect your API structures in a designated folder. You can also generate nested structures directly in the editor by pasting an example JSON response, making more complex response shapes easier to set up.
As your project grows, BluAPI’s dependency graph helps you see how base URLs, endpoints, named calls, structures, and Blueprint call sites connect. Double-click a base URL, endpoint, or named call to open a focused view of its dependencies. Open referenced structures and Blueprint call sites directly from the graph to quickly find the assets you need.
Dependencies
BluAPI uses Unreal Engine's built-in Editor Scripting Utilities plugin for saving editor assets, API configurations, and generated structures. This dependency is automatically enabled for editor use.
▛▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▝▗
▋ Define reusable base URLs, endpoints, and named API calls directly in the editor. ▗
▋ Send asynchronous HTTP requests through Blueprint Call and AUTH nodes.
▋ Support for GET, POST, PUT, PATCH, DELETE, and HEAD requests.
▋ Configure path parameters, query parameters, and request headers.
▋ Serialize request structures using supported body encodings.
▋ Deserialize JSON responses into user-defined structures.
▋ Support for JWT authentication and experimental OAuth2 authentication flows.
▋ Generate nested Unreal structures from example JSON.
▋ Organize and inspect API structures through a dedicated interface.
▋ Visualize dependencies between API contracts, structures, and Blueprint call sites.
▋ Open focused dependency tabs for base URLs, endpoints, and named calls.
▋ Propagate name changes across linked definitions and supported Blueprint nodes. ▝
▙▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▗▝
[Support Channels]