Collections

​

Creating a New Collection

1. Click the “Add new” button in the collections section
2. Enter the collection name
3. Optionally add a description
4. Click “Create”

​

Save Requests to Collections

1. Configure your request (URL, method, headers, body, etc.)
2. Click the “Save” button
3. Select the collection and folder
4. Enter a request name
5. Click “Save”

• Click the dropdown next to “Save” button
• Select “Save as” to save to a different location
• Useful for creating variations of requests

​

Organizing Collections

​

Drag and Drop

• Drag requests between folders
• Drag folders to reorder
• Drag folders into other folders to create hierarchy
• Drag requests to reorder within a folder

​

Nested Structure

User Management API
├── Authentication
│   ├── Login
│   ├── Logout
│   └── Refresh Token
├── Users
│   ├── Get User
│   ├── Create User
│   ├── Update User
│   └── Delete User
└── Permissions
    ├── Get Permissions
    └── Update Permissions

​

Editing Collections

1. Right-click on the collection
2. Select “Edit”
3. Update name, description, or properties
4. Click “Save”

​

Adding Requests

1. Right-click on the collection or folder
2. Select “New request”
3. Configure the request
4. It will be automatically saved to that location

​

Duplicating Collections

1. Right-click on the collection
2. Select “Duplicate”
3. A copy will be created with ”- Copy” suffix
4. Rename as needed

• Create variations for different environments
• Backup before major changes
• Share modified version with team

​

Deleting Collections

1. Right-click on the collection
2. Select “Delete”
3. Confirm deletion

​

Importing Collections

​

From Postman

1. Export collection from Postman (v2.1 format)
2. Click “Import” in Auk
3. Select “Postman”
4. Choose the exported JSON file
5. Select destination folder
6. Click “Import”

​

From Insomnia

1. Export from Insomnia (JSON format)
2. Click “Import” in Auk
3. Select “Insomnia”
4. Choose the exported file
5. Click “Import”

​

From OpenAPI/Swagger

1. Have your OpenAPI spec file (JSON or YAML)
2. Click “Import” in Auk
3. Select “OpenAPI”
4. Choose the spec file or enter URL
5. Auk will generate requests from the spec
6. Click “Import”

​

From Auk

1. Export collections from Auk
2. Click “Import” in Auk
3. Select “Auk”
4. Choose the exported JSON file
5. Click “Import”

​

From cURL

1. Copy cURL command
2. Click “Import” in Auk
3. Select “cURL”
4. Paste the cURL command
5. Click “Import”

​

Exporting Collections

​

Export Formats

• Native format
• Preserves all features
• Best for backup and sharing with Auk users

• Compatible with Postman
• Good for sharing with Postman users
• Some Auk-specific features may not transfer

• Standard API specification
• Good for documentation
• Generates spec from requests

• Export individual requests as cURL commands
• Good for command-line usage
• Easy to share single requests

​

Export Steps

1. Right-click on collection
2. Select “Export”
3. Choose format
4. Select destination
5. Click “Export”

​

Collection Properties

​

Authorization

• None - No authentication
• Basic Auth - Username and password
• Bearer Token - Token-based auth
• OAuth 2.0 - OAuth flow
• API Key - API key in header or query
• Digest Auth - Digest authentication
• Hawk - Hawk authentication
• AWS Signature - AWS SigV4

• Subfolders inherit parent authorization
• Individual requests can override
• Use “Inherit” to use parent settings

​

Headers

Content-Type: application/json
Accept: application/json
User-Agent: Auk/1.0

• Content-Type - Request body format
• Accept - Response format
• Authorization - Auth token (if not using auth)
• User-Agent - Client identifier
• X-API-Key - API key

• Subfolders inherit parent headers
• Individual requests can add or override
• Duplicate headers are merged

​

Variables

baseUrl = https://api.example.com
apiVersion = v1
timeout = 30000

URL: <<baseUrl>>/<<apiVersion>>/users
Timeout: <<timeout>>

• Available to all requests in collection
• Can be overridden by environment variables
• Useful for collection-specific values

​

Git Sync Integration

​

Automatic Commits

Update users-api: Added new endpoint GET /users/:id
Update products-api: Modified request headers
Add new collection: Orders API
Delete collection: Legacy API

​

Viewing History

1. Right-click on collection
2. Select “View History”
3. See all commits affecting this collection
4. View diffs between versions
5. Restore previous versions if needed

​

Conflict Resolution

1. Auk detects conflicts during sync
2. Shows conflict resolution dialog
3. Choose resolution strategy:
   • Keep local changes
   • Use remote changes
   • Manual merge
4. Resolve and sync

​

Branching

1. Create feature branch
2. Make changes to collections
3. Push branch to remote
4. Create pull request
5. Merge after review

• Experimental endpoints
• Major API changes
• Team feature development

​

Collection Organization Best Practices

​

Naming Conventions

✅ Good:
- "User Management API"
- "Payment Service v2"
- "Internal Admin API"

❌ Bad:
- "Collection 1"
- "Test"
- "New Collection"

​

Folder Structure

API Collection
├── Users
├── Products
├── Orders
└── Payments

API Collection
├── Authentication
├── User Management
├── Shopping Cart
└── Checkout

API Collection
├── v1
│   ├── Users
│   └── Products
└── v2
    ├── Users
    └── Products

​

Documentation

• Purpose of the API
• Base URL
• Authentication requirements
• Common parameters
• Rate limits
• Contact information

​

Request Naming

✅ Good:
- "Get User by ID"
- "Create New Product"
- "Update Order Status"

❌ Bad:
- "Request 1"
- "Test"
- "GET"

​

Advanced Features

​

Collection Runner

1. Right-click on collection
2. Select “Run Collection”
3. Configure run settings:
   • Environment
   • Iterations
   • Delay between requests
4. Click “Run”
5. View results

• Integration testing
• Smoke testing
• Data seeding
• Batch operations

​

Collection Variables

// Pre-request script
const userId = Math.floor(Math.random() * 1000);
pw.env.set("userId", userId);

// Request URL
<<baseUrl>>/users/<<userId>>

​

Collection Scripts

// Runs before each request in collection
const timestamp = Date.now();
pw.env.set("timestamp", timestamp);

// Runs after each request in collection
pw.test("Status code is 200", () => {
  pw.expect(pw.response.status).toBe(200);
});

​

Collection Documentation

1. Right-click on collection
2. Select “Generate Documentation”
3. Choose format (Markdown, HTML)
4. Customize template
5. Export documentation

​

Troubleshooting

​

Collection Not Saving

1. Check workspace permissions
2. Verify disk space
3. Check auto-save settings
4. Manually save with Cmd/Ctrl + S

​

Import Failed

1. Verify file format
2. Check file is not corrupted
3. Try different import format
4. Check error message for details

​

Git Sync Issues

1. Check Git connection
2. Verify no conflicts
3. Manually trigger sync
4. Check Git credentials

​

Missing Requests

1. Check if accidentally moved to another folder
2. Check trash/deleted items
3. Restore from Git history
4. Check workspace is correct

​

Next Steps