Skip to main content

​
Organization Strategies

Choose an organization strategy that fits your workflow:

By Project

Separate workspace per project

By Client

One workspace per client

By Environment

Dev, staging, production workspaces

By Team

One workspace per team

​
By Project

Organize workspaces by project: 
~/Auk/
├── project-alpha/
│   ├── collections/
│   │   ├── backend-api.json
│   │   └── frontend-api.json
│   └── environments/
│       ├── dev.json
│       └── prod.json
├── project-beta/
└── project-gamma/
Best for:
  • Multiple independent projects
  • Different tech stacks
  • Separate teams per project

​
By Client

Organize by client or customer: 
~/Auk/
├── client-acme/
├── client-globex/
├── client-initech/
└── internal/
Best for:
  • Consulting/agency work
  • Multiple clients
  • Client-specific configurations

​
By Environment

Separate workspaces by environment: 
~/Auk/
├── development/
├── staging/
└── production/
Best for:
  • Testing environment-specific configurations
  • Preventing accidental production changes
  • Clear environment separation

​
Collection Organization

​
Folder Structure

Organize requests into logical folders: 
User Management API
├── Authentication
│   ├── Login
│   ├── Logout
│   └── Refresh Token
├── Users
│   ├── List Users
│   ├── Create User
│   ├── Get User
│   ├── Update User
│   └── Delete User
└── Roles
    ├── List Roles
    └── Assign Role

​
Naming Conventions

Use consistent naming: Collections:
  • User Management API
  • Payment Processing API
  • Notification Service API
Requests:
  • GET /users - List Users
  • POST /users - Create User
  • PUT /users/:id - Update User

​
Environment Management

​
Environment Strategy

One file per environment:
environments/
├── development.json
├── staging.json
└── production.json

​
Best Practices

Clear, descriptive names for everything:
  • Workspaces
  • Collections
  • Requests
  • Environments
Don’t over-organize:
  • Start simple
  • Add structure as needed
  • Avoid deep nesting
Add README.md to workspaces:
# Team API Collections

## Structure
- `auth/` - Authentication endpoints
- `users/` - User management
- `payments/` - Payment processing

## Environments
- `dev` - Local development
- `staging` - Staging server
- `prod` - Production (use carefully!)

​
Next Steps

Creating Workspaces

Create and configure workspaces

Git Collaboration

Team collaboration strategies

Local-First Workflow

Local-first best practices

Collections

Manage API collections