Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create openapi.json file using a TS to JSON generator #4

Open
KenEucker opened this issue Apr 14, 2021 · 1 comment
Open

Create openapi.json file using a TS to JSON generator #4

KenEucker opened this issue Apr 14, 2021 · 1 comment
Assignees
@KenEucker
Labels
someday-maybe

Comments

@KenEucker
Copy link
Owner

KenEucker commented Apr 14, 2021 •
edited
Loading

Using one of the following:

https://github.com/grantila/typeconv/
https://github.com/airtasker/spot
https://github.com/vega/ts-json-schema-generator
https://github.com/lukeautry/tsoa

We can generate an open API file that can be used in postman or to spin up a swagger UI explorer for testing the API or to generate serverside code or to generate an entire Saas project.
@KenEucker KenEucker self-assigned this Apr 14, 2021
@KenEucker KenEucker changed the title Create sawgger.json file using typeconv Create openapi.json file using a TS to JSON generator Dec 2, 2021
@KenEucker
Copy link
Owner Author

I believe that I have found the winning ticket with tsoa and spectacle:

https://github.com/lukeautry/tsoa
https://github.com/sourcey/spectacle

I am now starting on a BikeTagServer class that wraps the BikeTagClient with hollow wrappers for the main interfaces decorated with tsoa annotations and run through spectable to provide all sorts of solutions.

KenEucker added a commit that referenced this issue Dec 3, 2021
@KenEucker
feat(*): moves the core data types out of common/types and into commo…
d8ab3b9 
…n/schema and introduces tsoa

this update touches a lot of files, but the interfaces from here on out should not be changing in
any way. the addition of the server.ts file is an attempt to address #4, using tsoa. testing and
refinements still need to be made on that front. the schema file is also a move in the direction of
having this file be generated by the sanity project biketag-games.
@KenEucker KenEucker mentioned this issue Dec 3, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@KenEucker KenEucker

Labels
someday-maybe
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@KenEucker