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

Investigate how to strongly type API #48

Open

mikeqcp opened this issue Jan 24, 2020 · 1 comment

Labels

Contributor

mikeqcp commented Jan 24, 2020

We should consider options for strongly typing API request body & response formats.

Ideally this should be shared between BE & FE developers in some way, and on FE avaiable i.e. as Typescript interfaces.

mikeqcp added the enhancement label

Contributor Author

mikeqcp commented Jan 24, 2020

One option I can think about when dealing with Django BE is combination of those two tools:

https://www.django-rest-framework.org/api-guide/schemas/ It allows to generate endpoint metadata in openAPI format (including accepted parametrs & responses format)

https://github.com/manifoldco/swagger-to-ts It allows to parse openAPI schema and produces TS interfaces based on them

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment