starred/ArchiveBox

Fork 0

mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2026-04-25 09:06:02 +03:00

[PR #1397] [MERGED] REST API v1 using `django-ninja` #4415

New issue

Closed

opened 2026-03-15 01:43:22 +03:00 by kerem · 0 comments

kerem commented

2026-03-15 01:43:22 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/ArchiveBox/ArchiveBox/pull/1397
Author: @Brandl
Created: 4/9/2024
Status: ✅ Merged
Merged: 4/24/2024
Merged by: @pirate

Base: main ← Head: main

📝 Commits (2)

5f9aac1 api v1
99502bd Merge branch 'main' into main

📊 Changes

15 files changed (+2877 additions, -2395 deletions)

View changed files

➕ archivebox/api/__init__.py (+0 -0)
➕ archivebox/api/apps.py (+5 -0)
➕ archivebox/api/archive.py (+184 -0)
➕ archivebox/api/auth.py (+48 -0)
➕ archivebox/api/migrations/0001_initial.py (+28 -0)
➕ archivebox/api/migrations/__init__.py (+0 -0)
➕ archivebox/api/models.py (+30 -0)
➕ archivebox/api/tests.py (+27 -0)
📝 archivebox/core/settings.py (+1 -0)
📝 archivebox/core/urls.py (+9 -0)
➕ archivebox/index.sqlite3 (+0 -0)
📝 package-lock.json (+2371 -2393)
📝 pdm.lock (+105 -1)
📝 pyproject.toml (+1 -0)
📝 requirements.txt (+68 -1)

📄 Description

Summary

I recently integrated Archivebox with a small python script. The current approach of setting up the full django environment is somewhat cumbersome and limits usecases where the interaction is triggered by remote systems/containers.

So here goes my initial draft of a REST API based on django ninja.

For Auth I implemented Token/Bearer Auth. Token can be obtained and validated via API Endpoints.
Ideally there should be a UI (Django Admin,...) to make obtaining them more friendly to users.

The current API resembles the CLI for compatibility and simplicity.
Adding CRUD Endpoints should be rather straight forward.

Ideally Endpoints should return a TASK-ID for long running tasks for long polling or allow for SSE subscription.
This would require to update to Django 4.2 for async support.

Touches on all the API issues:
#496
#1126

Changes these areas

Token model
Token based authentication
ADD/UPDATE/REMOVE/LIST Endpoints
CRUD Endpoints for Snapshot/Link,...
UI for Token
Extensive Testing suite
(future) streaming/fully async endpoints

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/ArchiveBox/ArchiveBox/pull/1397 **Author:** [@Brandl](https://github.com/Brandl) **Created:** 4/9/2024 **Status:** ✅ Merged **Merged:** 4/24/2024 **Merged by:** [@pirate](https://github.com/pirate) **Base:** `main` ← **Head:** `main` --- ### 📝 Commits (2) - [`5f9aac1`](https://github.com/ArchiveBox/ArchiveBox/commit/5f9aac18f24cb73aa4789a14ae38ad04c4b1421c) api v1 - [`99502bd`](https://github.com/ArchiveBox/ArchiveBox/commit/99502bd9281368df77ef1464b881fd4ce67b569b) Merge branch 'main' into main ### 📊 Changes **15 files changed** (+2877 additions, -2395 deletions) <details> <summary>View changed files</summary> ➕ `archivebox/api/__init__.py` (+0 -0) ➕ `archivebox/api/apps.py` (+5 -0) ➕ `archivebox/api/archive.py` (+184 -0) ➕ `archivebox/api/auth.py` (+48 -0) ➕ `archivebox/api/migrations/0001_initial.py` (+28 -0) ➕ `archivebox/api/migrations/__init__.py` (+0 -0) ➕ `archivebox/api/models.py` (+30 -0) ➕ `archivebox/api/tests.py` (+27 -0) 📝 `archivebox/core/settings.py` (+1 -0) 📝 `archivebox/core/urls.py` (+9 -0) ➕ `archivebox/index.sqlite3` (+0 -0) 📝 `package-lock.json` (+2371 -2393) 📝 `pdm.lock` (+105 -1) 📝 `pyproject.toml` (+1 -0) 📝 `requirements.txt` (+68 -1) </details> ### 📄 Description  # Summary I recently integrated Archivebox with a small python script. The current approach of setting up the full django environment is somewhat cumbersome and limits usecases where the interaction is triggered by remote systems/containers. So here goes my initial draft of a REST API based on django ninja. For Auth I implemented Token/Bearer Auth. Token can be obtained and validated via API Endpoints. Ideally there should be a UI (Django Admin,...) to make obtaining them more friendly to users. The current API resembles the CLI for compatibility and simplicity. Adding CRUD Endpoints should be rather straight forward. Ideally Endpoints should return a TASK-ID for long running tasks for long polling or allow for SSE subscription. This would require to update to Django 4.2 for async support. # Related issues Touches on all the API issues: #496 #1126 # Changes these areas - [X] Token model - [x] Token based authentication - [X] ADD/UPDATE/REMOVE/LIST Endpoints - [x] CRUD Endpoints for Snapshot/Link,... - [ ] UI for Token - [ ] Extensive Testing suite - [ ] (future) streaming/fully async endpoints ![Screenshot from 2024-04-10 01-45-11](https://github.com/ArchiveBox/ArchiveBox/assets/3877188/2927b793-2769-466b-97b9-fb0a1333bd27) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

kerem

2026-03-15 01:43:22 +03:00

closed this issue
added the
pull-request
label

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/ArchiveBox#4415

No description provided.

Rows
Columns

[PR #1397] [MERGED] REST API v1 using django-ninja #4415