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

Use datasette-table Web Component to guide the design of the JSON API for 1.0 #1532

Open
simonw opened this issue Nov 28, 2021 · 4 comments
Open
Labels
json-api maybe-not-1.0 Things that might not need to block 1.0 after all
Milestone

Comments

@simonw
Copy link
Owner

simonw commented Nov 28, 2021

I realized that one of the reasons I'm having trouble committing to nailing down the JSON API for 1.0 is that I don't use it much myself - I use the ?_shape=array one quite often, but I don't have any projects that are using the default, more fully-featured API.

As an experiment I built a Web Component for embedding Datasette tables on pages - https://github.com/simonw/datasette-table - and I think it's actually going to be a really useful tool for helping me dog food the v1.0 API design.

@20after4
Copy link

FWIW I've written some web components that consume the json api and I think it's a really nice way to work with datasette. I like the combination with datasette+sqlite as a back-end feeding data to a front-end that's entirely javascript + html.

@simonw
Copy link
Owner Author

simonw commented Nov 30, 2021

That's really cool to hear - I've not seen many people actively building on top of the JSON API.

@20after4
Copy link

It's a really great API and the documentation is really great too. Honestly, in more than 20 years of professional experience, I haven't worked with any software API that was more of a joy to use.

@simonw
Copy link
Owner Author

simonw commented Mar 16, 2022

Could also build a CLI Rich/Textual app to exercise the API - which could embed Datasette as a dependency and work using datasette.client.get(...) calls.

Could be a plugin that adds a datasette tui command.

@simonw simonw added the maybe-not-1.0 Things that might not need to block 1.0 after all label Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
json-api maybe-not-1.0 Things that might not need to block 1.0 after all
Projects
None yet
Development

No branches or pull requests

2 participants