v0.4.1: Code-driven OpenAPI docs via swagger-jsdoc
Some checks failed
Build & Deploy to Staging / Build & Deploy to Staging (push) Has been cancelled
Some checks failed
Build & Deploy to Staging / Build & Deploy to Staging (push) Has been cancelled
- Add swagger-jsdoc dependency for auto-generating OpenAPI spec from JSDoc - Add JSDoc @openapi annotations to all route handlers - Create scripts/generate-openapi.mjs build step - OpenAPI spec now auto-generated from code — no manual JSON editing - All 13 endpoints documented with full parameters - New demo endpoints documented, signup marked as deprecated - Updated info description: demo-first, no free tier references - Dockerfile updated to run openapi generation during build - Build script updated: npm run build generates spec before compile
This commit is contained in:
parent
53755d6093
commit
792e2d9142
12 changed files with 1931 additions and 305 deletions
|
|
@ -5,10 +5,11 @@
|
|||
"main": "dist/index.js",
|
||||
"scripts": {
|
||||
"build:pages": "node scripts/build-pages.js && npx terser public/app.js -o public/app.min.js --compress --mangle",
|
||||
"build": "npm run build:pages && tsc",
|
||||
"build": "node scripts/generate-openapi.mjs && npm run build:pages && tsc",
|
||||
"start": "node dist/index.js",
|
||||
"dev": "tsx src/index.ts",
|
||||
"test": "vitest run"
|
||||
"test": "vitest run",
|
||||
"generate-openapi": "node scripts/generate-openapi.mjs"
|
||||
},
|
||||
"dependencies": {
|
||||
"compression": "^1.8.1",
|
||||
|
|
@ -22,6 +23,7 @@
|
|||
"pino": "^10.3.1",
|
||||
"puppeteer": "^24.0.0",
|
||||
"stripe": "^20.3.1",
|
||||
"swagger-jsdoc": "^6.2.8",
|
||||
"swagger-ui-dist": "^5.31.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
|
|
@ -36,4 +38,4 @@
|
|||
"vitest": "^3.0.0"
|
||||
},
|
||||
"type": "module"
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue