Add Swagger UI Documentation

devdaydresden / devday_website

The website code for https://www.devday.de/

BSD 3-Clause "New" or "Revised" License

8 stars 9 forks source link

Add Swagger UI Documentation #283

Closed jenslauterbach closed 2 years ago

jenslauterbach commented 2 years ago

This PR does add three new URLs, one of which does expose a Swagger UI for our API.

api/schema/swagger-ui/

To enable this feature I used the DRF Spectacular library (as suggested by the DRF documentation).

Important: At the moment the documentation requires authentication. I thought this would be a sane default considering, that the API requires authentication as well. Of course, this could be changed.

coveralls commented 2 years ago

Pull Request Test Coverage Report for Build 1677177214

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.001%) to 97.137%

Totals
Change from base Build 1674060656:	0.001%
Covered Lines:	3838
Relevant Lines:	3955

💛 - Coveralls

jandd commented 2 years ago

The build issue in https://github.com/devdaydresden/devday_website/runs/4753483954?check_suite_focus=true#step:5:6136 might be related to a setuptools or pip issue. Needs further investigation.