Best Practices

Best Practices

1. Initialize early -- Call WormaCeptorApi.init() at the start of Application.onCreate() before creating HTTP clients

2. Always use debugImplementation -- Never use implementation for persistence/imdb modules

3. Redact sensitive data -- Configure redactHeader() and redactJsonValue() for auth tokens, passwords, and PII before any network calls

4. Set content limits -- Keep maxContentLength reasonable (250KB-500KB) to avoid excessive memory/storage use

5. Use selective features -- Disable features you don't need to reduce initialization overhead

6. Record WebSocket sends -- OkHttp doesn't notify listeners of outgoing messages; always call recordSentMessage()

7. Handle overlay permissions -- Check canShowFloatingButton() before showing overlays and guide users to settings if needed

8. Use deep links for testing -- Deep links let you navigate directly to any tool programmatically

9. Register extension providers early -- Register before network traffic starts to capture metadata from the first request

10. Leverage no-op safety -- All WormaCeptor API calls are safe in release builds; no conditional wrapping needed