spdx-online-tools icon indicating copy to clipboard operation
spdx-online-tools copied to clipboard

Published 20 hours ago • verified publisher icon spdx

Add support for API documentation

Open Ugtan opened this issue 3 years ago • 4 comments

This PR adds support for API documentation with the help of drf-yasg library.

Ugtan avatar Aug 11 '21 11:08 Ugtan

@Ugtan How will this generate swagger specs? Can we host the file on github repo/wiki in some way?

rtgdk avatar Aug 15 '21 06:08 rtgdk

This will generate the api documentation on app/swagger and app/redoc endpoint. I don't think so there is any other way to generate it on wiki rather than writing it manually. @rtgdk

Ugtan avatar Aug 15 '21 16:08 Ugtan

@Ugtan ping

rtgdk avatar Aug 29 '21 17:08 rtgdk

@goneall @Ugtan Not merging this to python3 as it doesn't provide any value right now. The swagger spec generated are empty. Maybe we need to rethink where to provide the API request and response structure. drf-yasf doesn't seem to pick up parameters from views.py. Maybe I am missing something here. Open to suggestions on what to do next.

rtgdk avatar Mar 13 '22 17:03 rtgdk