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

Datasette 1.0 JSON API (and documentation) #1509

Open
simonw opened this issue Nov 15, 2021 · 3 comments
Open

Datasette 1.0 JSON API (and documentation) #1509

simonw opened this issue Nov 15, 2021 · 3 comments

Comments

@simonw
Copy link
Owner

simonw commented Nov 15, 2021

The new JSON API in a stable, documented form.

@simonw
Copy link
Owner Author

simonw commented Nov 16, 2021

This is mainly happening here:

@simonw simonw changed the title Datasette 1.0 JSON API Datasette 1.0 JSON API (and documentation) Mar 15, 2022
@simonw
Copy link
Owner Author

simonw commented Mar 15, 2022

Idea: I could add Pydantic https://pydantic-docs.helpmanual.io/usage/schema/ as an optional test dependency and use it to generate JSON schemas and run validation against examples in the API documentation.

Maybe generate API documentation from it too?

@simonw
Copy link
Owner Author

simonw commented Mar 15, 2022

... maybe Datasette itself should include interactive API documentation, in addition to documenting it in the manual?

/dbname/table/-/apidocs could return documentation about the specific table, taking into account columns and types.

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

No branches or pull requests

1 participant