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

discoverable and browseable REST API #983

Open
mpdehaan opened this issue Mar 21, 2022 · 1 comment
Open

discoverable and browseable REST API #983

mpdehaan opened this issue Mar 21, 2022 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@mpdehaan
Copy link

I notice right now that when running the very first basic demos the root of the web API is not discoverable so you can find other resources. While this is a start, having an index like ...

{
"comments" : "/api/comments/",
"users" : "/api/users/",
}

Is not all you can do. Django REST Framework had an amazing example with https://www.django-rest-framework.org/topics/browsable-api/ where you can PUT and POST from the web inteface, and everything is browseable hyperlinks

An API that is web-surfable makes an amazing demo and would be very good to show in the core documentation, videos, tutorials, and so on.

It really helps out when people are writing integrations against an API too.

@mpdehaan mpdehaan added the enhancement New feature or request label Mar 21, 2022
@penberg penberg self-assigned this Mar 22, 2022
@penberg
Copy link
Contributor

penberg commented Mar 22, 2022

@mpdehaan One option is to implement OpenAPI support and then integrate with Swagger. What are your thoughts on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants