I’ve been slowly working on a pull request that puts some working API docs tooling into place in edx-platform: https://github.com/edx/edx-platform/pull/21207 I’d love to hear comments about it. It uses drf-yasg and its swagger_auto_schema decorator, with Markdown for descriptions. It publishes bo…

This is exciting Ned, but I think I need some more context. What will this do once it’s merged?

I thought I had explained it on the PR, but I know it’s hard to step back and see it as others do, without the context. The goal of the PR is to make it possible to document our REST APIs in the Python code, then produce live Swagger docs at a url (/api-docs/) and also static documentation on readt…

[image] pdpinch: I think I need some more context. Hi @pdpinch , we’ve set up an OpenCraft sandbox if you want to have a look at the live API docs so far: https://pr21207.sandbox.opencraft.hosting/register or login as a demo user, e.g. staff@example.com / edx or honor@example.com / edx. ht…

REST API docs tooling pull request

Development

nedbat (Ned Batchelder) August 19, 2019, 9:04pm 5

I started another topic: Improved API documentation

Topic		Replies	Views
Improved API documentation Architecture api	5	2058	September 17, 2019
Next steps for API docs Architecture api	5	2020	October 1, 2019
REST API Documentation Build-Test-Release api	15	3603	September 18, 2020
Api-access-swagger Development api	1	735	August 26, 2022
Edx-platform REST API Documentation Development	10	1508	July 25, 2023

REST API docs tooling pull request

Related topics