Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add drf-restwind and update outdated images in browsable-api.md #9680

Merged
merged 4 commits into from
Apr 8, 2025
Merged

Add drf-restwind and update outdated images in browsable-api.md #9680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
84ca4e3
add drf-restwind
youzarsiph Apr 3, 2025
c4aa28f
Merge branch 'master' of https://github.com/youzarsiph/django-rest-fr…
youzarsiph Apr 3, 2025
f6a3910
Add images of 3rd party customization packages
youzarsiph Apr 7, 2025
b0f211c
Merge branch 'encode:master' into master
youzarsiph Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/community/third-party-packages.md
View file
Open in desktop
Copy link

@ulgens ulgens Apr 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes in this file should be enough for the scope of this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your review! I wanted to highlight that all the changes in this PR are related. It might be useful to consider them together during the review process.

Let me know if you need any further input!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes in this file should be enough for the scope of this PR.

I don't know. The browsable API page has a few 3rd party packages in the same space already listed in it... Adding drf-restwind to it makes sense to me

Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ To submit new content, [create a pull request][drf-create-pr].

### Customization

* [drf-restwind][drf-restwind] - a modern re-imagining of the Django REST Framework utilizes TailwindCSS and DaisyUI to provide flexible and customizable UI solutions with minimal coding effort.
* [drf-redesign][drf-redesign] - A project that gives a fresh look to the browse-able API using Bootstrap 5.
* [drf-material][drf-material] - A project that gives a sleek and elegant look to the browsable API using Material Design.

Expand Down Expand Up @@ -254,6 +255,7 @@ To submit new content, [create a pull request][drf-create-pr].
[django-requestlogs]: https://github.com/Raekkeri/django-requestlogs
[drf-standardized-errors]: https://github.com/ghazi-git/drf-standardized-errors
[drf-api-action]: https://github.com/Ori-Roza/drf-api-action
[drf-restwind]: https://github.com/youzarsiph/drf-restwind
[drf-redesign]: https://github.com/youzarsiph/drf-redesign
[drf-material]: https://github.com/youzarsiph/drf-material
[django-pyoidc] : https://github.com/makinacorpus/django_pyoidc
[django-pyoidc]: https://github.com/makinacorpus/django_pyoidc
Binary file added docs/img/drf-m-api-root.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/drf-m-detail-view.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/drf-m-list-view.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/drf-r-api-root.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/drf-r-detail-view.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/drf-r-list-view.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/drf-rw-api-root.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/drf-rw-detail-view.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/drf-rw-list-view.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/img/rfm.png
View file
Open in desktop
Binary file not shown.
Binary file removed docs/img/rfr.png
View file
Open in desktop
Binary file not shown.
51 changes: 40 additions & 11 deletions docs/topics/browsable-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,22 +81,43 @@ For more specific CSS tweaks than simply overriding the default bootstrap theme

### Third party packages for customization

You can use a third party package for customization, rather than doing it by yourself. Here is 2 packages for customizing the API:
You can use a third party package for customization, rather than doing it by yourself. Here is 3 packages for customizing the API:

* [rest-framework-redesign][rest-framework-redesign] - A package for customizing the API using Bootstrap 5. Modern and sleek design, it comes with the support for dark mode.
* [rest-framework-material][rest-framework-material] - Material design for Django REST Framework.
* [drf-restwind][drf-restwind] - a modern re-imagining of the Django REST Framework utilizes TailwindCSS and DaisyUI to provide flexible and customizable UI solutions with minimal coding effort.
* [drf-redesign][drf-redesign] - A package for customizing the API using Bootstrap 5. Modern and sleek design, it comes with the support for dark mode.
* [drf-material][drf-material] - Material design for Django REST Framework.

---

![Django REST Framework Redesign][rfr]
![API Root][drf-rw-api-root]

*Screenshot of the rest-framework-redesign*
![List View][drf-rw-list-view]

![Detail View][drf-rw-detail-view]

*Screenshots of the drf-restwind*

---

---

![API Root][drf-r-api-root]

![List View][drf-r-list-view]

![Detail View][drf-r-detail-view]

*Screenshot of the drf-redesign*

---

![Django REST Framework Material][rfm]
![API Root][drf-m-api-root]

![List View][drf-m-api-root]

![Detail View][drf-m-api-root]

*Screenshot of the rest-framework-material*
*Screenshot of the drf-material*

---

Expand Down Expand Up @@ -197,7 +218,15 @@ There are [a variety of packages for autocomplete widgets][autocomplete-packages
[bcomponentsnav]: https://getbootstrap.com/2.3.2/components.html#navbar
[autocomplete-packages]: https://www.djangopackages.com/grids/g/auto-complete/
[django-autocomplete-light]: https://github.com/yourlabs/django-autocomplete-light
[rest-framework-redesign]: https://github.com/youzarsiph/rest-framework-redesign
[rest-framework-material]: https://github.com/youzarsiph/rest-framework-material
[rfr]: ../img/rfr.png
[rfm]: ../img/rfm.png
[drf-restwind]: https://github.com/youzarsiph/drf-restwind
[drf-rw-api-root]: ../img/drf-rw-api-root.png
[drf-rw-list-view]: ../img/drf-rw-list-view.png
[drf-rw-detail-view]: ../img/drf-rw-detail-view.png
[drf-redesign]: https://github.com/youzarsiph/drf-redesign
[drf-r-api-root]: ../img/drf-r-api-root.png
[drf-r-list-view]: ../img/drf-r-list-view.png
[drf-r-detail-view]: ../img/drf-r-detail-view.png
[drf-material]: https://github.com/youzarsiph/drf-material
[drf-m-api-root]: ../img/drf-m-api-root.png
[drf-m-list-view]: ../img/drf-m-list-view.png
[drf-m-detail-view]: ../img/drf-m-detail-view.png
Loading