oeplatform icon indicating copy to clipboard operation
oeplatform copied to clipboard

add swagger ui to make API endpoints more visible:

Open jh-RLI opened this issue 2 years ago • 1 comments

for dev purpose (not sure if this will be implemented in production)

  • see list of api endpoints at URL .../api/swagger-ui
  • to generate the api schema that is mandatory to show swagger ui:
    • pip install pyyaml uritemplate
    • python manage.py generateschema --file api/static/openapi-schema.yml
    • python manage.py collectstatic _ makesure the openapi-schema.yml is present in the gloabl /static/ folder

jh-RLI avatar May 31 '22 10:05 jh-RLI

preview: image

jh-RLI avatar May 31 '22 13:05 jh-RLI