Mentorship-backend: Swagger UI is not being generated

Created on 3 Jan 2019  路  3Comments  路  Source: anitab-org/mentorship-backend

Describe the bug

After the latest merge https://github.com/systers/mentorship-backend/pull/158 the Swagger UI is not being generated.

The API is working, and it can be tested using other tools and the Android client, but this is bad for who wants to test the backend API without additional tools (like Postman).

To Reproduce
Steps to reproduce the behavior:

  1. Go to http://systers-mentorship-dev.eu-central-1.elasticbeanstalk.com/
  2. You won't see the Swagger UI generated

Expected behavior

Swagger UI should appear.

Screenshots

This is what is showing up:

what is showing up

This should show up:
swagger ui example

Additional context

The problem was introduced here: https://github.com/systers/mentorship-backend/pull/158
I'm looking at this but any help would be appreciated.

The problem is with the usage of flask restplus. See the docs here: https://flask-restplus.readthedocs.io/en/stable/

Coding Available Bug

All 3 comments

I'm thinking this could be related with the use of field.Nested:
image

Investigating ...

By commenting on this line of code Swagger UI will be generated.

As you can see below:

image

It's fixed, by adding this missing description :D

image

Was this page helpful?
0 / 5 - 0 ratings

Related issues

isabelcosta picture isabelcosta  路  26Comments

isabelcosta picture isabelcosta  路  22Comments

Shivansh2407 picture Shivansh2407  路  25Comments

gaurivn picture gaurivn  路  19Comments

epicadk picture epicadk  路  27Comments