This repository has been archived by the owner on Aug 11, 2024. It is now read-only.
feat: add tool to generate OpenAPI spec #336
Draft
Conversation
This file contains 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
wpf500
force-pushed
the
feat/929-api-docs
branch
from
d29e77f to
c315dd7
Compare
JumpLink
reviewed
Jan 12, 2024
Base automatically changed from
feat/917-new-validations
to
feat/917-response-validation
January 17, 2024 18:22
wpf500
force-pushed
the
feat/929-api-docs
branch
from
37dd5cd to
134cb79
Compare
wpf500
force-pushed
the
feat/929-api-docs
branch
from
134cb79 to
abf3113
Compare
wpf500
changed the title
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR adds experimental generation of an OpenAPI spec
It uses the packages routing-controllers-openapi and class-validator-jsonchema to generate the OpenAPI spec. It needs quite a bit of nudging in the right direction with extra decorators due to limitations in TypeScript type reflection.
In particular:
Promise<T>(so basically all of them) have a@ResponseSchema(T)decoratorPaginatedDto<GetContactDto>->GetContactListDto. This is because class-validation-schema can't process generics, so derived classes are necessaryGetAddressDtoextends fromUpdateAddressDto) have been merged. This was only an attempt at consistency and class-validation-schema can't generate JSONSchema for these classes (as they aren't registered with class-validator)This means there is quite a lot of boilerplate in controllers and on DTOs, but I think it's good enough for now and pretty cool to be able to generate some fairly useable docs so easily :).
To do
GetSignupFlowDto, etc.) to feat: validate API responses #333GET /content/:idendpointThe docs 📖