3 use BookStack\Http\Controllers\Api\ApiDocsController;
4 use BookStack\Http\Controllers\Api\AttachmentApiController;
5 use BookStack\Http\Controllers\Api\BookApiController;
6 use BookStack\Http\Controllers\Api\BookExportApiController;
7 use BookStack\Http\Controllers\Api\BookshelfApiController;
8 use BookStack\Http\Controllers\Api\ChapterApiController;
9 use BookStack\Http\Controllers\Api\ChapterExportApiController;
10 use BookStack\Http\Controllers\Api\PageApiController;
11 use BookStack\Http\Controllers\Api\PageExportApiController;
12 use BookStack\Http\Controllers\Api\RecycleBinApiController;
13 use BookStack\Http\Controllers\Api\SearchApiController;
14 use BookStack\Http\Controllers\Api\UserApiController;
15 use Illuminate\Support\Facades\Route;
18 * Routes for the BookStack API.
19 * Routes have a uri prefix of /api/.
20 * Controllers are all within app/Http/Controllers/Api.
22 Route::get('docs.json', [ApiDocsController::class, 'json']);
24 Route::get('attachments', [AttachmentApiController::class, 'list']);
25 Route::post('attachments', [AttachmentApiController::class, 'create']);
26 Route::get('attachments/{id}', [AttachmentApiController::class, 'read']);
27 Route::put('attachments/{id}', [AttachmentApiController::class, 'update']);
28 Route::delete('attachments/{id}', [AttachmentApiController::class, 'delete']);
30 Route::get('books', [BookApiController::class, 'list']);
31 Route::post('books', [BookApiController::class, 'create']);
32 Route::get('books/{id}', [BookApiController::class, 'read']);
33 Route::put('books/{id}', [BookApiController::class, 'update']);
34 Route::delete('books/{id}', [BookApiController::class, 'delete']);
36 Route::get('books/{id}/export/html', [BookExportApiController::class, 'exportHtml']);
37 Route::get('books/{id}/export/pdf', [BookExportApiController::class, 'exportPdf']);
38 Route::get('books/{id}/export/plaintext', [BookExportApiController::class, 'exportPlainText']);
39 Route::get('books/{id}/export/markdown', [BookExportApiController::class, 'exportMarkdown']);
41 Route::get('chapters', [ChapterApiController::class, 'list']);
42 Route::post('chapters', [ChapterApiController::class, 'create']);
43 Route::get('chapters/{id}', [ChapterApiController::class, 'read']);
44 Route::put('chapters/{id}', [ChapterApiController::class, 'update']);
45 Route::delete('chapters/{id}', [ChapterApiController::class, 'delete']);
47 Route::get('chapters/{id}/export/html', [ChapterExportApiController::class, 'exportHtml']);
48 Route::get('chapters/{id}/export/pdf', [ChapterExportApiController::class, 'exportPdf']);
49 Route::get('chapters/{id}/export/plaintext', [ChapterExportApiController::class, 'exportPlainText']);
50 Route::get('chapters/{id}/export/markdown', [ChapterExportApiController::class, 'exportMarkdown']);
52 Route::get('pages', [PageApiController::class, 'list']);
53 Route::post('pages', [PageApiController::class, 'create']);
54 Route::get('pages/{id}', [PageApiController::class, 'read']);
55 Route::put('pages/{id}', [PageApiController::class, 'update']);
56 Route::delete('pages/{id}', [PageApiController::class, 'delete']);
58 Route::get('pages/{id}/export/html', [PageExportApiController::class, 'exportHtml']);
59 Route::get('pages/{id}/export/pdf', [PageExportApiController::class, 'exportPdf']);
60 Route::get('pages/{id}/export/plaintext', [PageExportApiController::class, 'exportPlainText']);
61 Route::get('pages/{id}/export/markdown', [PageExportApiController::class, 'exportMarkDown']);
63 Route::get('search', [SearchApiController::class, 'all']);
65 Route::get('shelves', [BookshelfApiController::class, 'list']);
66 Route::post('shelves', [BookshelfApiController::class, 'create']);
67 Route::get('shelves/{id}', [BookshelfApiController::class, 'read']);
68 Route::put('shelves/{id}', [BookshelfApiController::class, 'update']);
69 Route::delete('shelves/{id}', [BookshelfApiController::class, 'delete']);
71 Route::get('users', [UserApiController::class, 'list']);
72 Route::post('users', [UserApiController::class, 'create']);
73 Route::get('users/{id}', [UserApiController::class, 'read']);
74 Route::put('users/{id}', [UserApiController::class, 'update']);
75 Route::delete('users/{id}', [UserApiController::class, 'delete']);
77 Route::get('recycle-bin', [RecycleBinApiController::class, 'list']);
78 Route::put('recycle-bin/{deletionId}', [RecycleBinApiController::class, 'restore']);
79 Route::delete('recycle-bin/{deletionId}', [RecycleBinApiController::class, 'destroy']);