REST API frontend abstraction - Githubissues

ContactEngineering / ce-ui

User interface of contact.engineering

https://contact.engineering

MIT License

0 stars 0 forks source link

REST API frontend abstraction #69

Open pastewka opened 6 months ago

pastewka commented 6 months ago

The code currently directly interacts with the REST API, in the sense that individual components issue GET, PUT etc. requests and consume the output.

This issue suggests refactoring part of this code to mirror backend ORM classes in the frontend.

Suggested steps:

Implement OpenAPI documentation for the backend, e.g. using django-spectacular
Generate automatic frontend classes, e.g. using openapi-ts
Switch code to use this abstraction layer

A key advantage of this is:

Checking the reponse against a schema (encoded in the frontend classes)
Easier testing because those classes can be mocked

pastewka commented 5 months ago

See also: https://github.com/ContactEngineering/topobank/issues/1094