-
Notifications
You must be signed in to change notification settings - Fork 0
FAQ
A: REST Express is a Unity editor extension that converts Postman collections into Unity-ready API clients. It allows you to test API endpoints directly in the Unity Editor and generate clean, maintainable C# code.
A: REST Express supports Unity 2020.3 LTS and later versions. It's regularly tested with the latest LTS releases.
A: REST Express is available on the Unity Asset Store. Check our store page for pricing details.
A: Yes! REST Express generates both async and coroutine versions of your API methods. You can choose which style to use based on your needs.
A: Yes, REST Express fully supports file uploads through multipart/form-data requests. See our Examples for implementation details.
A: Absolutely! REST Express offers extensive customization options through:
- Custom templates
- Naming conventions
- Type generation rules
- Base classes See our Code Generation Guide for details.
A: REST Express supports various authentication methods:
- Bearer tokens
- API keys
- Custom headers
- OAuth flows
Implement the
IAuthProvider
interface for custom authentication.
A: Yes, REST Express works with WebGL builds. However, consider:
- CORS policies (ensure your server includes appropriate CORS headers)
- SSL/HTTPS requirements
- Browser security restrictions
A: Yes, REST Express handles HTTPS connections and certificates. For development environments with self-signed certificates, use the provided certificate handler.
A: Best practices include:
- Group related endpoints in folders
- Use consistent naming conventions
- Document request/response examples
- Utilize variables for common values See Best Practices for detailed guidance.
A: Yes, REST Express supports Postman environment variables. They can be:
- Imported with collections
- Overridden locally
- Used in generated code
A: REST Express provides several error handling options:
- Try-catch blocks with ApiException
- Error callbacks in coroutines
- Global error handlers See Error Handling examples.
A: Common reasons include:
- Invalid JSON format
- Unsupported Postman version
- Missing required fields See Troubleshooting for solutions.
A: Check these common issues:
- Missing dependencies
- Incorrect Unity version
- Invalid type references See Compilation Errors.
A: To report bugs:
- Check existing issues
- Provide reproduction steps
- Include error messages
- Share collection sample (if possible)
A: We regularly update REST Express with:
- Bug fixes
- New features
- Unity compatibility updates
- Performance improvements
A: Support options include:
- Documentation
- Issue tracker
- Email support: [email protected]
- Unity Asset Store comments
A: Yes! We welcome feature requests through:
- GitHub issues
- Asset Store reviews
A: We recommend:
- Group related endpoints
- Use meaningful names
- Document responses
- Handle errors consistently See Best Practices for more.
A: Choose based on your needs:
- Async: Modern C# development, better error handling
- Coroutines: Unity-specific workflows, simpler integration
A: Best practices include:
- Keep collections updated
- Use version control
- Document customizations
- Follow naming conventions