feat: create request validation & openapi spec generation library - #46
Open
jumpy-cat wants to merge 17 commits into
Open
feat: create request validation & openapi spec generation library#46jumpy-cat wants to merge 17 commits into
jumpy-cat wants to merge 17 commits into
Conversation
|
Checked in Backend meeting: I would add more detail to this PR |
These wrappers add zod-based input validation, type-safety, and reflection capabilities. To be used in the future for generating openapi definitions.
Also reordered the definitions so that the main api is together and closer to the top + fixed a bug where req & res bodies were mixed up.
…t and response schemas
Make sure the passed schemas can accept strings as input as that is what express gives as `path` and `query`. Update module docs.
The previous approach of supporting many status codes and having a 2XX entry in the generated OpenAPI spec doesn't work well with swagger_parser. Switch to using only the 200 status code and having an entry for 200 instead.
jumpy-cat
force-pushed
the
http-api-docs
branch
from
August 2, 2026 02:01
78ac5c0 to
bd25c46
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Created a library that will enable the creation of always up to date openapi specs for the backend. The design I went with also enforces request validation and responses are checked by the typechecker, both also good to have.
Type of Change
feat)fix)Related Issues
Progress towards #40
Depends on #45
Changes Made
Testing Done
Flutter:
Screenshots / Demo (if UI or notification change)
Checklist
[type](scope): short descriptionmainand is our current working update branch (e.g.maizebus2.1)print()/debugPrint()/console.log()left in production code