Skip to content

Commit 5ca9cc6

Browse files
committed
feat: add comprehensive OpenAPI documentation and refactor routes
- Add Swagger/OpenAPI documentation for all API endpoints (files, code, notes, folders, users) - Refactor route files into modular folder structure (crud/actions/trash/counts) - Fix TypeScript type inference issues with OpenAPIHono validators - Fix route registration order to prevent /{id} catching /empty-trash - Increase file download rate limit to 1000 req/15min in development - Add Swagger docs link to README (https://api.typelets.com/docs)
1 parent 5591f54 commit 5ca9cc6

File tree

22 files changed

+2707
-764
lines changed

22 files changed

+2707
-764
lines changed

CHANGELOG.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
## [1.7.2](https://github.com/typelets/typelets-api/compare/v1.7.1...v1.7.2) (2025-10-15)
22

3-
43
### Bug Fixes
54

6-
* restore JSON string format for CloudWatch compatibility ([dc2b7aa](https://github.com/typelets/typelets-api/commit/dc2b7aa8474ade322fcc383db7b103f1796ef6c4))
5+
- restore JSON string format for CloudWatch compatibility ([dc2b7aa](https://github.com/typelets/typelets-api/commit/dc2b7aa8474ade322fcc383db7b103f1796ef6c4))
76

87
## [1.7.1](https://github.com/typelets/typelets-api/compare/v1.7.0...v1.7.1) (2025-10-15)
98

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,8 @@ If you prefer to install PostgreSQL locally instead of Docker:
170170

171171
## API Endpoints
172172

173+
📚 **Full API documentation with interactive examples available at [https://api.typelets.com/docs](https://api.typelets.com/docs)** (Swagger/OpenAPI)
174+
173175
### Public Endpoints
174176

175177
- `GET /` - API information and health status

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@
3939
"dependencies": {
4040
"@clerk/backend": "^2.5.0",
4141
"@hono/node-server": "^1.15.0",
42-
"@hono/zod-validator": "^0.7.0",
42+
"@hono/swagger-ui": "^0.5.2",
43+
"@hono/zod-openapi": "^1.1.3",
44+
"@hono/zod-validator": "^0.7.2",
4345
"@types/ws": "^8.18.1",
4446
"dotenv": "^17.0.1",
4547
"dotenv-flow": "^4.1.0",
@@ -49,7 +51,7 @@
4951
"newrelic": "latest",
5052
"postgres": "^3.4.7",
5153
"ws": "^8.18.3",
52-
"zod": "^3.25.67"
54+
"zod": "^4.1.12"
5355
},
5456
"devDependencies": {
5557
"@eslint/js": "^9.37.0",

pnpm-lock.yaml

Lines changed: 74 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)