fossasia / badgeyay

Attendee Badge Generator for Conferences
GNU General Public License v3.0
1.79k stars 446 forks source link

Add Swagger UI #437

Closed vaibhavsingh97 closed 6 years ago

vaibhavsingh97 commented 6 years ago

I'm submitting a ...

Current behavior: Swagger UI is not present

Expected behavior: As this PR: https://github.com/fossasia/badgeyay/commit/82d6fcd79b087ba96d6cf4c20c1d075ed50a9c97 merged
We need to add Swagger UI. Swagger does a simple but very powerful thing: with a bit of additional annotations it generates the REST API descriptions (HTTP methods, path / query / form parameters, responses, HTTP error codes, ...) and even provides a simple web UI to play with REST calls to your APIs (not to mention that all this metadata is available over REST as well).

Yes, I want to work on the issue

vaibhavsingh97 commented 6 years ago

Claiming

abishekvashok commented 6 years ago

@vaibhavsingh97 closing this as we prefer a ember js one instead :)

vaibhavsingh97 commented 6 years ago

@abishekvashok This is not related to frontend, this is for easy documentation of API

abishekvashok commented 6 years ago

I am sorry! Reopening

S2606 commented 6 years ago

@vaibhavsingh97 Are you facing any issue working on this?

vaibhavsingh97 commented 6 years ago

@S2606 will send PR latest by tomorrow

S2606 commented 6 years ago

@vaibhavsingh97 If you are not working on this.Can I?

vaibhavsingh97 commented 6 years ago

I am working on this issue

vaibhavsingh97 commented 6 years ago

@djmgit I will use flasgger for adding Swagger UI. Flasgger also provides validation of the incoming data, using the same specification it can validates if the data received as as a POST, PUT, PATCH is valid against the schema defined using YAML, Python dictionaries or Marshmallow Schemas.

vaibhavsingh97 commented 6 years ago

We can also use flask_restplus. It has a feature which automatically generates interactive documentation for your API using Swagger UI.

vaibhavsingh97 commented 6 years ago

@djmgit @ParthS007 @gabru-md @yashLadha Your opinion please