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.

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

DRF-like Browsable API? #1

Closed
sloria opened this issue Oct 29, 2015 · 3 comments
Closed

DRF-like Browsable API? #1

sloria opened this issue Oct 29, 2015 · 3 comments

Comments

@sloria
Copy link
Owner

sloria commented Oct 29, 2015

Proposal: Port django-rest-framework's browsable API .

Considerations:

@sloria sloria changed the title Browse-able API? DRF-like Browsable API? Oct 29, 2015
@jettify
Copy link

jettify commented Oct 30, 2015

I have similar thoughts for long time, but have not started it myself because:

  1. DRF rely on ORM , where a lot of information is available, asyncio does not have proper ORM yet (but will have not in distant future). Otherwise we force user to describe data structure of input/output, I believe browsable api should be semi auto generated and should require minimum user interaction.
  2. Browsable API should be part of generic REST framework, witch is other story how to implement

I think aiohttp_api deserves separate package even if aiohttp_debugtoolbar will have REST toolbar.

@sloria
Copy link
Owner Author

sloria commented Oct 31, 2015

Valid points. DRF's browsable API is useful insofar as it can introspect DRF Serializers and can therefore generate forms for POST/PUT/etc. Otherwise, it wouldn't provide much more than a GUI client like Postman.

I am more inclined to target language/framework-agnostic API specs such as Swagger, from which a UI can be generated. I might add an aiohttp plugin for apispec if there's interest.

@sloria
Copy link
Owner Author

sloria commented Mar 18, 2017

Holding off on this for now.

@sloria sloria closed this as completed Mar 18, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants