Customize theme & styling of browseable REST API #9249

Open
opened 2025-12-29 20:47:28 +01:00 by adam · 0 comments
Owner

Originally created by @jeremystretch on GitHub (Feb 14, 2024).

NetBox version

v3.7.2

Feature type

Change to existing functionality

Proposed functionality

When requested by a browser, NetBox's REST API endpoints return a human-readable HTML rendering of the relevant data (a nice bonus feature of Django REST framework), as seen below.

screenshot

In light of the complete UI refresh for NetBox v4.0, we should take some time to incorporate elements of the new theme for the browseable API as well. This can be done by overriding and extending DRF's default HTML templates.

Use case

Customization of the browseable REST API will provide a more consistent feel and better UX.

Database changes

N/A

External dependencies

N/A

Originally created by @jeremystretch on GitHub (Feb 14, 2024). ### NetBox version v3.7.2 ### Feature type Change to existing functionality ### Proposed functionality When requested by a browser, NetBox's REST API endpoints return a human-readable HTML rendering of the relevant data (a nice bonus feature of [Django REST framework](https://www.django-rest-framework.org/topics/browsable-api/)), as seen below. ![screenshot](https://github.com/netbox-community/netbox/assets/13487278/32ebc83b-ed51-4ad2-a9e0-ab21a7a1a88d) In light of the [complete UI refresh]() for NetBox v4.0, we should take some time to incorporate elements of the new theme for the browseable API as well. This can be done by overriding and extending DRF's default HTML templates. ### Use case Customization of the browseable REST API will provide a more consistent feel and better UX. ### Database changes N/A ### External dependencies N/A
adam added the type: featurenetboxneeds milestonestatus: backlogcomplexity: low labels 2025-12-29 20:47:28 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#9249