BookStack Code Mirror - bookstack/blob - routes/api.php

   1 <?php
   2
   3 /**
   4  * Routes for the BookStack API.
   5  * Routes have a uri prefix of /api/.
   6  * Controllers all end with "ApiController"
   7  */
   8
   9 use BookStack\Activity\Controllers\AuditLogApiController;
  10 use BookStack\Api\ApiDocsController;
  11 use BookStack\Entities\Controllers as EntityControllers;
  12 use BookStack\Exports\Controllers as ExportControllers;
  13 use BookStack\Permissions\ContentPermissionApiController;
  14 use BookStack\Search\SearchApiController;
  15 use BookStack\Uploads\Controllers\AttachmentApiController;
  16 use BookStack\Uploads\Controllers\ImageGalleryApiController;
  17 use BookStack\Users\Controllers\RoleApiController;
  18 use BookStack\Users\Controllers\UserApiController;
  19 use Illuminate\Support\Facades\Route;
  20
  21 Route::get('docs.json', [ApiDocsController::class, 'json']);
  22
  23 Route::get('attachments', [AttachmentApiController::class, 'list']);
  24 Route::post('attachments', [AttachmentApiController::class, 'create']);
  25 Route::get('attachments/{id}', [AttachmentApiController::class, 'read']);
  26 Route::put('attachments/{id}', [AttachmentApiController::class, 'update']);
  27 Route::delete('attachments/{id}', [AttachmentApiController::class, 'delete']);
  28
  29 Route::get('books', [EntityControllers\BookApiController::class, 'list']);
  30 Route::post('books', [EntityControllers\BookApiController::class, 'create']);
  31 Route::get('books/{id}', [EntityControllers\BookApiController::class, 'read']);
  32 Route::put('books/{id}', [EntityControllers\BookApiController::class, 'update']);
  33 Route::delete('books/{id}', [EntityControllers\BookApiController::class, 'delete']);
  34
  35 Route::get('books/{id}/export/html', [ExportControllers\BookExportApiController::class, 'exportHtml']);
  36 Route::get('books/{id}/export/pdf', [ExportControllers\BookExportApiController::class, 'exportPdf']);
  37 Route::get('books/{id}/export/plaintext', [ExportControllers\BookExportApiController::class, 'exportPlainText']);
  38 Route::get('books/{id}/export/markdown', [ExportControllers\BookExportApiController::class, 'exportMarkdown']);
  39
  40 Route::get('chapters', [EntityControllers\ChapterApiController::class, 'list']);
  41 Route::post('chapters', [EntityControllers\ChapterApiController::class, 'create']);
  42 Route::get('chapters/{id}', [EntityControllers\ChapterApiController::class, 'read']);
  43 Route::put('chapters/{id}', [EntityControllers\ChapterApiController::class, 'update']);
  44 Route::delete('chapters/{id}', [EntityControllers\ChapterApiController::class, 'delete']);
  45 Route::get('chapters/{id}/export/html', [ExportControllers\ChapterExportApiController::class, 'exportHtml']);
  46 Route::get('chapters/{id}/export/pdf', [ExportControllers\ChapterExportApiController::class, 'exportPdf']);
  47 Route::get('chapters/{id}/export/plaintext', [ExportControllers\ChapterExportApiController::class, 'exportPlainText']);
  48 Route::get('chapters/{id}/export/markdown', [ExportControllers\ChapterExportApiController::class, 'exportMarkdown']);
  49
  50 Route::get('pages', [EntityControllers\PageApiController::class, 'list']);
  51 Route::post('pages', [EntityControllers\PageApiController::class, 'create']);
  52 Route::get('pages/{id}', [EntityControllers\PageApiController::class, 'read']);
  53 Route::put('pages/{id}', [EntityControllers\PageApiController::class, 'update']);
  54 Route::delete('pages/{id}', [EntityControllers\PageApiController::class, 'delete']);
  55
  56 Route::get('pages/{id}/export/html', [ExportControllers\PageExportApiController::class, 'exportHtml']);
  57 Route::get('pages/{id}/export/pdf', [ExportControllers\PageExportApiController::class, 'exportPdf']);
  58 Route::get('pages/{id}/export/plaintext', [ExportControllers\PageExportApiController::class, 'exportPlainText']);
  59 Route::get('pages/{id}/export/markdown', [ExportControllers\PageExportApiController::class, 'exportMarkdown']);
  60
  61 Route::get('image-gallery', [ImageGalleryApiController::class, 'list']);
  62 Route::post('image-gallery', [ImageGalleryApiController::class, 'create']);
  63 Route::get('image-gallery/{id}', [ImageGalleryApiController::class, 'read']);
  64 Route::put('image-gallery/{id}', [ImageGalleryApiController::class, 'update']);
  65 Route::delete('image-gallery/{id}', [ImageGalleryApiController::class, 'delete']);
  66
  67 Route::get('search', [SearchApiController::class, 'all']);
  68
  69 Route::get('shelves', [EntityControllers\BookshelfApiController::class, 'list']);
  70 Route::post('shelves', [EntityControllers\BookshelfApiController::class, 'create']);
  71 Route::get('shelves/{id}', [EntityControllers\BookshelfApiController::class, 'read']);
  72 Route::put('shelves/{id}', [EntityControllers\BookshelfApiController::class, 'update']);
  73 Route::delete('shelves/{id}', [EntityControllers\BookshelfApiController::class, 'delete']);
  74
  75 Route::get('users', [UserApiController::class, 'list']);
  76 Route::post('users', [UserApiController::class, 'create']);
  77 Route::get('users/{id}', [UserApiController::class, 'read']);
  78 Route::put('users/{id}', [UserApiController::class, 'update']);
  79 Route::delete('users/{id}', [UserApiController::class, 'delete']);
  80
  81 Route::get('roles', [RoleApiController::class, 'list']);
  82 Route::post('roles', [RoleApiController::class, 'create']);
  83 Route::get('roles/{id}', [RoleApiController::class, 'read']);
  84 Route::put('roles/{id}', [RoleApiController::class, 'update']);
  85 Route::delete('roles/{id}', [RoleApiController::class, 'delete']);
  86
  87 Route::get('recycle-bin', [EntityControllers\RecycleBinApiController::class, 'list']);
  88 Route::put('recycle-bin/{deletionId}', [EntityControllers\RecycleBinApiController::class, 'restore']);
  89 Route::delete('recycle-bin/{deletionId}', [EntityControllers\RecycleBinApiController::class, 'destroy']);
  90
  91 Route::get('content-permissions/{contentType}/{contentId}', [ContentPermissionApiController::class, 'read']);
  92 Route::put('content-permissions/{contentType}/{contentId}', [ContentPermissionApiController::class, 'update']);
  93
  94 Route::get('audit-log', [AuditLogApiController::class, 'list']);