shynet
shynet copied to clipboard
milesmcc
Add an API
Usually I use Django REST Framework for API but in this case it could be overkill. If there are plans for full API I can rewrite it using DRF. I added additional argument to service.get_core_stats() to return less data. Tokens can be managed only from Django admin.
Just wanted to thank you for putting in the work for this PR. I think that before we add an API we should stabilize what our method for handling new "custom" events will be, so while I'm not ready to merge quite yet, I think we'll be there soon. Going to leave this open for the time being.
I propose we do this a bit differently: instead of having a complex API token setup, we simply add a "refreshable" API URL for every service (and in that URL is a token, but that token is tied to . In the service's management page, we can show that URL — along with a button to "regenerate" it. So for example, a service might have the following API URL: https://shynet.com/api/service/286ff19d-6062-4033-ba83-d27f3c0f8ef8/?token=fjkhdslfhlkjdsahf (where the token is stored inside the service model, and not another model).
This approach might be simpler because it allows us to not think about authorization as much, and it means that API tokens don't need to be coupled to users.
It will work for me because I'm the only user of my shynet instance and I have only a few services. The problem begins with multi-users instance with a dozen services. For example there are 10 services and 5 users. All users get access to all services so everybody gets 10 links and add them to some kind of a client. If we want to revoke the access to one user we need to refresh 10 tokens and resend them to 4 users and they need update them in a client.
I really want to keep Shynet small and focused, so maybe we just make it one refreshable API token per user instead? I really hesitate to introduce an additional model.
One token per user is a good idea. I will apply changes. Should I add new view for API token or add it to security view or leave it to django admin?
Great. Let’s create a new view for token management. We can also show the token on the service management page.
Alright, thanks again for making this PR. I just played around with it in my local environment, and I think we're nearly there! Still, there are a few more things we need:
- We need some documentation about how the API works. I mostly mean in places like GUIDE.md, but I also mean in the interface itself. Right now if you visit the API page, it has no context — we need to explain what is going on. For example, we should explain that this is the user's personal API token.
- I don't think there should be a separate API tab. Perhaps we put it under "Account" or "Security"?
- I'm not sure it makes sense to put the API key without any context on the service management page. Instead, I think we should provide the link to the API where the user can access that service's information. I think that would be more directly useful.
I can make the interface look a bit more consistent/prettier myself before we merge, so don't worry too much about that. Thanks!
I moved API token info to security tab and rename it to 'Personal API token'. I added some basic API usage description to service management page and GUIDE.md.
I tried to add django-cors-headers but it generated conflict in poetry.lock. I'm not sure how to resolve this conflict.
In my local dev environment, I get the following error when I try to query the API for a particular service:
ERROR Internal Server Error: /api/dashboard/
Traceback (most recent call last):
File "/Users/miles/Library/Caches/pypoetry/virtualenvs/shynet--o1YXJxF-py3.9/lib/python3.9/site-packages/django/core/handlers/exception.py", line 47, in inner
response = get_response(request)
File "/Users/miles/Library/Caches/pypoetry/virtualenvs/shynet--o1YXJxF-py3.9/lib/python3.9/site-packages/django/core/handlers/base.py", line 181, in _get_response
response = wrapped_callback(request, *callback_args, **callback_kwargs)
File "/Users/miles/Library/Caches/pypoetry/virtualenvs/shynet--o1YXJxF-py3.9/lib/python3.9/site-packages/django/views/generic/base.py", line 70, in view
return self.dispatch(request, *args, **kwargs)
File "/Users/miles/Source/shynet/shynet/api/mixins.py", line 23, in dispatch
return super().dispatch(request, *args, **kwargs)
File "/Users/miles/Library/Caches/pypoetry/virtualenvs/shynet--o1YXJxF-py3.9/lib/python3.9/site-packages/django/views/generic/base.py", line 98, in dispatch
return handler(request, *args, **kwargs)
File "/Users/miles/Source/shynet/shynet/api/views.py", line 38, in get
services_data = [
File "/Users/miles/Source/shynet/shynet/api/views.py", line 43, in <listcomp>
'stats': s.get_core_stats(start, end, basic),
TypeError: get_core_stats() takes from 1 to 3 positional arguments but 4 were given
@haaavk see https://github.com/haaavk/shynet/compare/api...milesmcc:shynet:api