datasette icon indicating copy to clipboard operation
datasette copied to clipboard

Published 20 hours ago • verified publisher icon simonw

Datasette 1.0 JSON API (and documentation)

Open simonw opened this issue 3 years ago • 3 comments

The new JSON API in a stable, documented form.

simonw avatar Nov 15 '21 23:11 simonw

This is mainly happening here:

  • https://github.com/simonw/datasette/issues/782

simonw avatar Nov 16 '21 18:11 simonw

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 avatar Mar 15 '22 20:03 simonw

... 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.

simonw avatar Mar 15 '22 20:03 simonw