vuex-orm
vuex-orm copied to clipboard
vuex-orm
generate vuex-orm models based on json schema
Is your feature request related to a problem? Please describe...
Some servers implement a description of the models employed by the API using json-schema and Standards developed by "OpenAPI"-project:
- Json-Schema: http://json-schema.org/
- OpenAPI: https://swagger.io/specification/
This library here gen generate APIs in multiple languages:
https://github.com/OpenAPITools/openapi-generator
As an example, the framework "FastAPI" which is used for generating REST-APIs automatically generates the json schema based on the models defined. This json schema could easily be taken in order to generate models for vuex-orm. In the case of FastAPI the json schema is also embedded in the API itself and can be requested by clients. So we could even automatically adapt the schema in vuex-orm based on changes in the server.
- https://fastapi.tiangolo.com/features/#fastapi-features
Describe the solution you'd like
A function which creates models for Vuex-ORM based on a json schema.
Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered. Out-of-the-box javscript solutions such as:
https://www.npmjs.com/package/jsonschema
But I am not sure how easy it is to integrate that with vuex-orm.
EDIT: update links
This would be a killer feature for sure. Without it, one must maintain the models (schemas) both on client and server manually.
@yeus @PetrPy I'm in the early stages of planning a proof of concept for this: https://github.com/Truemedia/vuex-orm-jsonschema
Will post updates here once I make some progress in my free time
