-
Notifications
You must be signed in to change notification settings - Fork 0
Getting Started
AQaddora edited this page May 3, 2025
·
3 revisions
Welcome to REST Express! This guide will help you get up and running with REST Express in your Unity project.
Before you begin, ensure you have:
- Unity 2020.3 LTS or later
- A Postman collection (v2.1 format)
- Basic understanding of REST APIs
- .NET 4.x scripting runtime
- Download REST Express from the Unity Asset Store
- Import the package into your Unity project via:
- Assets → Import Package → Custom Package...
- Select the downloaded .unitypackage file
- The REST Express tools will appear under the "SyE" menu in Unity
-
Import Your Collection
- Open the REST Express window (SyE → REST Express)
- Click "Import Collection"
- Select your Postman collection JSON file
-
Test Your APIs
- Select any request from the collection tree
- Fill in any required parameters
- Click "Send Request" to test
- View the response in real-time
-
Generate Code
- Open the Script Generator (SyE → Script Generator)
- Select your collection
- Choose Async or Coroutine mode
- Click "Generate" to create your API client
The REST Express window has two main components:
- API Importer: Test and manage your API requests
- Script Generator: Generate C# client code
Your Postman collection will appear in a tree view:
- Folders organize related requests
- Click any request to view/edit details
- Right-click for context actions
- Use the toolbar for common actions
Each request can be tested with:
- Custom headers
- Query parameters
- Request body (JSON/Form data)
- File uploads
- Variable substitution
The Script Generator offers:
- Choice between Async and Coroutine methods
- Customizable class names
- Clean, documented code
- Proper error handling
- Type-safe requests/responses
Now that you're set up, explore these topics:
- API Reference for detailed functionality
- Code Generation Guide for customization options
- Best Practices for optimal usage
- Examples for common scenarios
- Troubleshooting for common issues
Need help? Check our Troubleshooting guide or contact support.