mirror of https://github.com/usememos/memos.git
133695da24
This commit addresses API design inconsistencies identified during
standardization review against Google AIP (API Improvement Proposals)
and REST API best practices.
## Changes Made
### 1. WorkspaceSetting Resource Namespace (proto)
- Fixed: `api.memos.dev/WorkspaceSetting` → `memos.api.v1/WorkspaceSetting`
- Location: proto/api/v1/workspace_service.proto (lines 57, 181)
- Impact: Aligns with consistent namespace pattern used across all other resources
### 2. Identity Provider HTTP Paths (proto)
- Changed: `/api/v1/identityProviders` → `/api/v1/identity-providers`
- Changed: `identityProviders/{idp}` → `identity-providers/{idp}`
- Location: proto/api/v1/idp_service.proto (all HTTP annotations and resource pattern)
- Rationale: REST conventions prefer lowercase with hyphens (kebab-case) over camelCase
- Follows: GitHub API standards and industry best practices
### 3. Backend Resource Name Constants (Go)
- Updated: `IdentityProviderNamePrefix = "identity-providers/"`
- Location: server/router/api/v1/resource_name.go:19
- Impact: Ensures resource name parsing matches new proto pattern
### 4. Backend Tests (Go)
- Updated all hardcoded identity provider resource names
- Location: server/router/api/v1/test/idp_service_test.go
- Changed: `identityProviders/*` → `identity-providers/*` (4 occurrences)
### 5. Frontend Constants (TypeScript)
- Updated: `identityProviderNamePrefix = "identity-providers/"`
- Location: web/src/store/common.ts:4
- Impact: Frontend resource name handling aligns with backend
## Breaking Changes
⚠️ **IMPORTANT**: This is a breaking change for Identity Provider API consumers.
**Before:**
```
GET /api/v1/identityProviders
GET /api/v1/identityProviders/123
```
**After:**
```
GET /api/v1/identity-providers
GET /api/v1/identity-providers/123
```
**Migration:** API clients must update URLs from `identityProviders` to `identity-providers`.
## Next Steps Required
1. **Regenerate proto code** (requires buf CLI):
```bash
cd proto
buf generate
```
This will update:
- proto/gen/api/v1/*.pb.go (Go generated code)
- proto/gen/api/v1/*.pb.gw.go (gRPC-Gateway code)
- web/src/types/proto/api/v1/*.ts (TypeScript definitions)
- proto/gen/openapi.yaml (OpenAPI spec)
2. **Test thoroughly:**
- Backend tests: `go test ./server/router/api/v1/test/...`
- Frontend integration tests
- Manual API testing with new paths
3. **Update documentation:**
- API documentation mentioning identity provider endpoints
- Migration guides for existing API consumers
## References
- Google AIP-122: Resource names
- Google AIP-132: Standard List methods
- REST API naming conventions (lowercase with hyphens)
- GitHub API design standards
## Binary Endpoint Design (No Changes)
After research, confirmed that the current `/file/*` path for binary content
is correct and follows best practices:
- Separates binary content delivery from structured API responses
- Enables easier CDN integration and caching
- Follows Google's pattern of using google.api.HttpBody with distinct paths
|
||
|---|---|---|
| .. | ||
| api/v1 | ||
| gen | ||
| store | ||
| README.md | ||
| buf.gen.yaml | ||
| buf.lock | ||
| buf.yaml | ||