Schema Generator ABC (or interface)

encode / apistar

The Web API toolkit. 🛠

https://docs.apistar.com

BSD 3-Clause "New" or "Revised" License

5.57k stars 411 forks source link

Schema Generator ABC (or interface) #640

Closed carltongibson closed 5 years ago

carltongibson commented 5 years ago

DRF has schema generators. Starlette has schema generators. It would be nice if APIStar provided an ABC (or protocol or interface) that we could follow there (or anywhere).

e.g. Methods like get_path_parameters() should be more or less standard.

It might be that this could just be a documentation thing: I may not want to import APIStar just for an ABC.

tomchristie commented 5 years ago

Sorry you'll have to expand on this for me.

carltongibson commented 5 years ago

Don't worry: Starlette schema generation is not similar enough to DRF's to warrant this: ends up reducing to "c.f. OpenAPI Docs". If things evolve differently I'll come back to it. Sorry for the noise.