SamStudio8 / majora2

Malleable All-seeing Journal Of Research Artifacts

MIT License

36 stars 7 forks source link

Documentation #23

Closed SamStudio8 closed 3 years ago

SamStudio8 commented 4 years ago

API docs with redoc or swagger
Developing docs for common features (adding a field)

SamStudio8 commented 4 years ago

See https://redocly.github.io/redoc/?url=http://majora.covid19.climb.ac.uk/static/majora.yaml

SamStudio8 commented 4 years ago

I initially had a swagger ui interface built into Majora, but it seems more sensible to just serve the YAML statically and point viewers at it. Long term, this would be another huge benefit of using Django REST, but for now, I'm much happier.

SamStudio8 commented 3 years ago

44

SamStudio8 commented 3 years ago

I don't like the DRF autodoc fwiw. Hand-rolled YAML for redoc is fine, but actually I think hand-written API github pages was the way to go all along...