mathesar icon indicating copy to clipboard operation
mathesar copied to clipboard

Published 20 hours ago • verified publisher icon mathesar-foundation

Setup API documentation and Postman collection

Open pavish opened this issue 3 years ago • 2 comments

  • Having a dedicated API documentation would make things easier for quick reference of our APIs as well as for anyone developing clients for Mathesar. Personal preference: Redoc
  • Postman collections make it easier to store, query, test and share APIs. Having one would make development and debugging easier. (Optional - just an idea)

Related Discussion

  • #875

pavish avatar Apr 27 '21 15:04 pavish

This issue has not been updated in 90 days and is being marked as stale.

github-actions[bot] avatar Oct 26 '21 21:10 github-actions[bot]

Hi @pavish I too felt the need of this feature while trying to understand all the present API endpoints and its allowable parameters. May be we can also think of Swagger!

ManishShah120 avatar Mar 10 '22 11:03 ManishShah120

This issue has not been updated in 90 days and is being marked as stale.

github-actions[bot] avatar Apr 06 '23 21:04 github-actions[bot]

I'm closing this because it seems out of date. In 2023 we had a GSoC project to document the API, and that project made some slightly different decisions from what is specified in this ticket description.

seancolsen avatar Nov 19 '23 16:11 seancolsen