p5.js-web-editor icon indicating copy to clipboard operation
p5.js-web-editor copied to clipboard

pr05 Typescript Migration - Followon Project: Swagger / OpenApi documentation & UI for server routes

Open clairep94 opened this issue 2 months ago • 0 comments

Proof of concept: Enable devs to look at open api/swagger documentation site on local dev only

  • Follow-on project from the pr05 Typescript Migration
  • Currently only contains user routes while other server items are not yet migrated

https://github.com/user-attachments/assets/13f87f8d-fb6b-48eb-9549-67c13873b3ee

Changes:

  • [x] Create /common/openapi.yaml with basic formatting + user routes & schemas
  • [x] Add dependencies for serving open api/swagger ui
  • [x] Add /open-api route to local dev only

I have verified that this pull request:

  • [ ] has no linting errors (npm run lint)
  • [ ] has no test errors (npm run test)
  • [ ] is from a uniquely-named feature branch and is up to date with the develop branch.
  • [ ] is descriptively named and links to an issue number, i.e. Fixes #123
  • [ ] meets the standards outlined in the accessibility guidelines

clairep94 avatar Oct 27 '25 14:10 clairep94