🔌
API Catalog
FreeA template for managing API endpoints in one list. Organize methods, paths, auth schemes, and release status so your dev team can share the spec.
Endpoint | Method | Path | Auth | Version | Status | Description | Notes | |
|---|---|---|---|---|---|---|---|---|
| 1 | List Users | GET | /api/v1/users | Bearer | v1 | Live | Returns registered users as a list | Supports pagination |
| 2 | Create User | POST | /api/v1/users | Bearer | v1 | Live | Registers a new user | Duplicate email returns 409 |
| 3 | Update User | PATCH | /api/v1/users/:id | Bearer | v1 | Live | Partially updates user info | Send only changed fields |
| 4 | Delete User | DELETE | /api/v1/users/:id | Bearer | v1 | Live | Removes a user | Soft delete |
| 5 | Login | POST | /api/v1/auth/login | None | v1 | Live | Issues an access token | Returns 401 on failure |
| 6 | List Articles | GET | /api/v2/articles | API Key | v2 | Live | Fetches published articles | Filterable by tag |
| 7 | Create Article | POST | /api/v2/articles | Bearer | v2 | Live | Creates a new article | Draft saving supported |
| 8 | Upload Image | POST | /api/v2/uploads | Bearer | v2 | In Development | Stores an image file | Max 10MB |
| 9 | Legacy Search | GET | /api/v1/search | API Key | v1 | Deprecated | Keyword search | Migrating to v2 soon |
| 10 | List Notifications | GET | /api/v2/notifications | OAuth | v2 | In Development | Returns unread notifications | WebSocket under consideration |
全10件
0
0
0
0
Posts0
Followers0
LikesProperties
Table
English
Comments
No comments yet
Be the first to comment