✨: Added swagger for API documentation

[BlackHawk0]

Description

Intergrated use of swagger and drf spectacular for API documentation.
For an quick alternative to postman, swagger allows users to do all requests from the browser which is abit lightweight.

Dependecies

• drf-spectacular
• django-rest-swagger

Fixes # (issue)

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• This change requires a documentation update

How Has This Been Tested?

Test Configuration:

          python manage.py migrate
          python manage.py test

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[github-actions]

Hello Contributor,👋👋 Thank You For Opening This Pull Request 🎉🎉

Welcome to SpaceYaTech

We are the fastest growing Africa Open-Source Community Looking To Change The Way Young Africans Get Started In Technology.

JOIN US | THRIVE | GROW

It's great having you contribute to this project

Welcome to the community 🤓 🍿 **Fun facts** - we eat bugs 🐛🐛🐛🐛 for breakfast 🥣

This Pull request has been queued for `review`

Sit tight the maintainers are on your case.

Soon the maintainers/owner will review it and provide you with feedback suggestions.
If you think it's something urgent, feel free to reach out

[JimmyTron]

LGTM

[collinskasyoki]

The /schema/docs/ path works perfectly. Details everything.
However I am not sure whether the /schema/ path should return JSON or YAML. It seems to return a YAML config as indicated in the screenshot below.

@BlackHawk0 @JimmyTron
Please confirm on what the behavior should be.

[BlackHawk0]

The /schema/docs/ path works perfectly. Details everything. However I am not sure whether the /schema/ path should return JSON or YAML. It seems to return a YAML config as indicated in the screenshot below.

@BlackHawk0 @JimmyTron Please confirm on what the behavior should be.

That's the desired ouput when you hit the schema endpoint.

However, the swagger UI for all the API endpoints is at schema/docs/

[collinskasyoki]

All Good.