Skip to content

Customize theme & styling of browseable REST API #15153

@jeremystretch

Description

@jeremystretch

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    complexity: lowRequires minimal effort to implementneeds milestoneAwaiting prioritization for inclusion with a future NetBox releasenetboxstatus: backlogAwaiting selection for worktype: featureIntroduction of new functionality to the application

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions