4 * Routes for the BookStack API.
5 * Routes have a uri prefix of /api/.
6 * Controllers all end with "ApiController"
9 use BookStack\Activity\Controllers\AuditLogApiController;
10 use BookStack\Api\ApiDocsController;
11 use BookStack\App\SystemApiController;
12 use BookStack\Entities\Controllers as EntityControllers;
13 use BookStack\Exports\Controllers as ExportControllers;
14 use BookStack\Permissions\ContentPermissionApiController;
15 use BookStack\Search\SearchApiController;
16 use BookStack\Uploads\Controllers\AttachmentApiController;
17 use BookStack\Uploads\Controllers\ImageGalleryApiController;
18 use BookStack\Users\Controllers\RoleApiController;
19 use BookStack\Users\Controllers\UserApiController;
20 use Illuminate\Support\Facades\Route;
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', [EntityControllers\BookApiController::class, 'list']);
31 Route::post('books', [EntityControllers\BookApiController::class, 'create']);
32 Route::get('books/{id}', [EntityControllers\BookApiController::class, 'read']);
33 Route::put('books/{id}', [EntityControllers\BookApiController::class, 'update']);
34 Route::delete('books/{id}', [EntityControllers\BookApiController::class, 'delete']);
36 Route::get('books/{id}/export/html', [ExportControllers\BookExportApiController::class, 'exportHtml']);
37 Route::get('books/{id}/export/pdf', [ExportControllers\BookExportApiController::class, 'exportPdf']);
38 Route::get('books/{id}/export/plaintext', [ExportControllers\BookExportApiController::class, 'exportPlainText']);
39 Route::get('books/{id}/export/markdown', [ExportControllers\BookExportApiController::class, 'exportMarkdown']);
41 Route::get('chapters', [EntityControllers\ChapterApiController::class, 'list']);
42 Route::post('chapters', [EntityControllers\ChapterApiController::class, 'create']);
43 Route::get('chapters/{id}', [EntityControllers\ChapterApiController::class, 'read']);
44 Route::put('chapters/{id}', [EntityControllers\ChapterApiController::class, 'update']);
45 Route::delete('chapters/{id}', [EntityControllers\ChapterApiController::class, 'delete']);
46 Route::get('chapters/{id}/export/html', [ExportControllers\ChapterExportApiController::class, 'exportHtml']);
47 Route::get('chapters/{id}/export/pdf', [ExportControllers\ChapterExportApiController::class, 'exportPdf']);
48 Route::get('chapters/{id}/export/plaintext', [ExportControllers\ChapterExportApiController::class, 'exportPlainText']);
49 Route::get('chapters/{id}/export/markdown', [ExportControllers\ChapterExportApiController::class, 'exportMarkdown']);
51 Route::get('pages', [EntityControllers\PageApiController::class, 'list']);
52 Route::post('pages', [EntityControllers\PageApiController::class, 'create']);
53 Route::get('pages/{id}', [EntityControllers\PageApiController::class, 'read']);
54 Route::put('pages/{id}', [EntityControllers\PageApiController::class, 'update']);
55 Route::delete('pages/{id}', [EntityControllers\PageApiController::class, 'delete']);
57 Route::get('pages/{id}/export/html', [ExportControllers\PageExportApiController::class, 'exportHtml']);
58 Route::get('pages/{id}/export/pdf', [ExportControllers\PageExportApiController::class, 'exportPdf']);
59 Route::get('pages/{id}/export/plaintext', [ExportControllers\PageExportApiController::class, 'exportPlainText']);
60 Route::get('pages/{id}/export/markdown', [ExportControllers\PageExportApiController::class, 'exportMarkdown']);
62 Route::get('image-gallery', [ImageGalleryApiController::class, 'list']);
63 Route::post('image-gallery', [ImageGalleryApiController::class, 'create']);
64 Route::get('image-gallery/{id}', [ImageGalleryApiController::class, 'read']);
65 Route::put('image-gallery/{id}', [ImageGalleryApiController::class, 'update']);
66 Route::delete('image-gallery/{id}', [ImageGalleryApiController::class, 'delete']);
68 Route::get('search', [SearchApiController::class, 'all']);
70 Route::get('shelves', [EntityControllers\BookshelfApiController::class, 'list']);
71 Route::post('shelves', [EntityControllers\BookshelfApiController::class, 'create']);
72 Route::get('shelves/{id}', [EntityControllers\BookshelfApiController::class, 'read']);
73 Route::put('shelves/{id}', [EntityControllers\BookshelfApiController::class, 'update']);
74 Route::delete('shelves/{id}', [EntityControllers\BookshelfApiController::class, 'delete']);
76 Route::get('users', [UserApiController::class, 'list']);
77 Route::post('users', [UserApiController::class, 'create']);
78 Route::get('users/{id}', [UserApiController::class, 'read']);
79 Route::put('users/{id}', [UserApiController::class, 'update']);
80 Route::delete('users/{id}', [UserApiController::class, 'delete']);
82 Route::get('roles', [RoleApiController::class, 'list']);
83 Route::post('roles', [RoleApiController::class, 'create']);
84 Route::get('roles/{id}', [RoleApiController::class, 'read']);
85 Route::put('roles/{id}', [RoleApiController::class, 'update']);
86 Route::delete('roles/{id}', [RoleApiController::class, 'delete']);
88 Route::get('recycle-bin', [EntityControllers\RecycleBinApiController::class, 'list']);
89 Route::put('recycle-bin/{deletionId}', [EntityControllers\RecycleBinApiController::class, 'restore']);
90 Route::delete('recycle-bin/{deletionId}', [EntityControllers\RecycleBinApiController::class, 'destroy']);
92 Route::get('content-permissions/{contentType}/{contentId}', [ContentPermissionApiController::class, 'read']);
93 Route::put('content-permissions/{contentType}/{contentId}', [ContentPermissionApiController::class, 'update']);
95 Route::get('audit-log', [AuditLogApiController::class, 'list']);
97 Route::get('system', [SystemApiController::class, 'read']);
projects / bookstack / blob