Nautobot
Non-Model REST API Plugin Development? #1817
-
|
Hi All I've just started diving into making a REST API endpoint in my nautobot plugin. I'm trying to make a rest endpoint which is not tied to a nautobot model, and I'm totally lost. The nautobot documentation only includes examples for building a rest API endpoint using a ModelViewSet on a custom model. I tried following the django_rest_framework documentation for creating a non-model The solution to that problem was to add Trouble is, the documentation in django_rest_framework for non-model views leverages At this point, I'm completely lost. Any tips or advice would be really appreciated! |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment 3 replies
-
|
So These are set by default via the You should safely be able to remove the EDIT: See below why |
Beta Was this translation helpful? Give feedback.
-
|
Hmmm.... I must be missing something. I tried that, and now I get this when I attempt to GET the endpoint: |
Beta Was this translation helpful? Give feedback.
-
|
Ah! So AuthN works as expected but AuthZ (permissions) needs to be changed. Our You'll need to define and specify your own permission class in this instance, see: https://www.django-rest-framework.org/api-guide/permissions/ So correction to my comment above: You don't need to specify |
Beta Was this translation helpful? Give feedback.
-
|
Ahhhhhhhh, ok! Thank you! I got it working now thanks to you For anyone else who's wondering, here's my working code so far: # api/views.py
from rest_framework import permissions
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status
class ArubaBlacklistView(APIView):
"""
Get the current aggregated stm blacklist (aka wireless auth blacklist)
From the aruba controllers, or remove an entry from the blacklist
"""
permission_classes = [permissions.IsAuthenticated]
def get(self, request, format=None):
data = [{"mac-address": "blahblahblah"}] # TODO: get the actual data
return Response(data)
def post(self, request, format=None):
data=request.data
# TODO: implement this method
return Response(data, status=status.HTTP_201_CREATED)
# return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)# api/urls.py
from django.urls import path
from .views import ArubaBlacklistView
urlpatterns = [
path('aruba-blacklist/', ArubaBlacklistView.as_view(), name='aruba-blacklist'),
]And it works exactly as expected! $ curl -H 'Authorization: Token <my token>' -H "Accept: application/json;" -s https://<my nautobot server>/api/plugins/utsc/aruba-blacklist/ | jq .
[
{
"mac-address": "blahblahblah"
}
] |
Beta Was this translation helpful? Give feedback.
So
ModelViewSeteventually inherits fromAPIView(viaModelViewSet>GenericViewSet>GenericAPIView>APIView) and nowhere in the chain does it do anything fancy with theauthentication_classes.These are set by default via the
settings.py:You should safely be able to remove the
authentication_classesandfrom their documented example.permission_classesEDIT: See below why
permission_classesmust be set.