devrules.directory

REST API Versioning

// Implements proper versioning strategy for REST APIs

APIBackendRESTBest Practices
Highly Rated
Community Verified

// detailed.guidelines

# REST API Versioning

Always version your APIs to maintain backward compatibility and allow for evolution.

## Versioning Strategies

### 1. URL Path Versioning (Recommended)
```
/api/v1/users
/api/v2/users
```

### 2. Header Versioning
```
Accept: application/vnd.myapi.v1+json
```

### 3. Query Parameter
```
/api/users?version=1
```

## Best Practices
- Start with v1 from the beginning
- Document breaking changes clearly
- Maintain older versions for a defined period
- Communicate deprecation timelines to users

// related.rules

6 matches

Never Break Public APIs
// Never changes public APIs without explicit migration plan and approval
APIBest Practices
2 matching categories
Python Best Practices
// Follows Pythonic patterns and avoids common Python pitfalls
Best PracticesBackend
2 matching categories
Go Idiomatic Patterns
// Follows Go community conventions and idiomatic patterns
Best PracticesBackend
2 matching categories
Ask Before Large Refactors
// Always asks clarifying questions before making significant code changes
Best Practices
1 matching category
Never Invent Facts or Dependencies
// Always admits uncertainty instead of making up information about code or dependencies
Best Practices
1 matching category
Never Log Secrets or Tokens
// Prevents logging of sensitive data like passwords, tokens, and API keys
Best Practices
1 matching category