X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/04137e7c98cfe182f3c603e7d1acbc9a0ed524e7..refs/pull/5280/head:/routes/api.php diff --git a/routes/api.php b/routes/api.php index 0604ffd29..c0919d324 100644 --- a/routes/api.php +++ b/routes/api.php @@ -2,11 +2,93 @@ /** * Routes for the BookStack API. - * * Routes have a uri prefix of /api/. + * Controllers all end with "ApiController" */ +use BookStack\Activity\Controllers\AuditLogApiController; +use BookStack\Api\ApiDocsController; +use BookStack\Entities\Controllers as EntityControllers; +use BookStack\Permissions\ContentPermissionApiController; +use BookStack\Search\SearchApiController; +use BookStack\Uploads\Controllers\AttachmentApiController; +use BookStack\Uploads\Controllers\ImageGalleryApiController; +use BookStack\Users\Controllers\RoleApiController; +use BookStack\Users\Controllers\UserApiController; +use Illuminate\Support\Facades\Route; -// TODO - Authenticate middleware +Route::get('docs.json', [ApiDocsController::class, 'json']); -Route::get('books', 'BooksApiController@index'); \ No newline at end of file +Route::get('attachments', [AttachmentApiController::class, 'list']); +Route::post('attachments', [AttachmentApiController::class, 'create']); +Route::get('attachments/{id}', [AttachmentApiController::class, 'read']); +Route::put('attachments/{id}', [AttachmentApiController::class, 'update']); +Route::delete('attachments/{id}', [AttachmentApiController::class, 'delete']); + +Route::get('books', [EntityControllers\BookApiController::class, 'list']); +Route::post('books', [EntityControllers\BookApiController::class, 'create']); +Route::get('books/{id}', [EntityControllers\BookApiController::class, 'read']); +Route::put('books/{id}', [EntityControllers\BookApiController::class, 'update']); +Route::delete('books/{id}', [EntityControllers\BookApiController::class, 'delete']); + +Route::get('books/{id}/export/html', [EntityControllers\BookExportApiController::class, 'exportHtml']); +Route::get('books/{id}/export/pdf', [EntityControllers\BookExportApiController::class, 'exportPdf']); +Route::get('books/{id}/export/plaintext', [EntityControllers\BookExportApiController::class, 'exportPlainText']); +Route::get('books/{id}/export/markdown', [EntityControllers\BookExportApiController::class, 'exportMarkdown']); + +Route::get('chapters', [EntityControllers\ChapterApiController::class, 'list']); +Route::post('chapters', [EntityControllers\ChapterApiController::class, 'create']); +Route::get('chapters/{id}', [EntityControllers\ChapterApiController::class, 'read']); +Route::put('chapters/{id}', [EntityControllers\ChapterApiController::class, 'update']); +Route::delete('chapters/{id}', [EntityControllers\ChapterApiController::class, 'delete']); + +Route::get('chapters/{id}/export/html', [EntityControllers\ChapterExportApiController::class, 'exportHtml']); +Route::get('chapters/{id}/export/pdf', [EntityControllers\ChapterExportApiController::class, 'exportPdf']); +Route::get('chapters/{id}/export/plaintext', [EntityControllers\ChapterExportApiController::class, 'exportPlainText']); +Route::get('chapters/{id}/export/markdown', [EntityControllers\ChapterExportApiController::class, 'exportMarkdown']); + +Route::get('pages', [EntityControllers\PageApiController::class, 'list']); +Route::post('pages', [EntityControllers\PageApiController::class, 'create']); +Route::get('pages/{id}', [EntityControllers\PageApiController::class, 'read']); +Route::put('pages/{id}', [EntityControllers\PageApiController::class, 'update']); +Route::delete('pages/{id}', [EntityControllers\PageApiController::class, 'delete']); + +Route::get('pages/{id}/export/html', [EntityControllers\PageExportApiController::class, 'exportHtml']); +Route::get('pages/{id}/export/pdf', [EntityControllers\PageExportApiController::class, 'exportPdf']); +Route::get('pages/{id}/export/plaintext', [EntityControllers\PageExportApiController::class, 'exportPlainText']); +Route::get('pages/{id}/export/markdown', [EntityControllers\PageExportApiController::class, 'exportMarkdown']); + +Route::get('image-gallery', [ImageGalleryApiController::class, 'list']); +Route::post('image-gallery', [ImageGalleryApiController::class, 'create']); +Route::get('image-gallery/{id}', [ImageGalleryApiController::class, 'read']); +Route::put('image-gallery/{id}', [ImageGalleryApiController::class, 'update']); +Route::delete('image-gallery/{id}', [ImageGalleryApiController::class, 'delete']); + +Route::get('search', [SearchApiController::class, 'all']); + +Route::get('shelves', [EntityControllers\BookshelfApiController::class, 'list']); +Route::post('shelves', [EntityControllers\BookshelfApiController::class, 'create']); +Route::get('shelves/{id}', [EntityControllers\BookshelfApiController::class, 'read']); +Route::put('shelves/{id}', [EntityControllers\BookshelfApiController::class, 'update']); +Route::delete('shelves/{id}', [EntityControllers\BookshelfApiController::class, 'delete']); + +Route::get('users', [UserApiController::class, 'list']); +Route::post('users', [UserApiController::class, 'create']); +Route::get('users/{id}', [UserApiController::class, 'read']); +Route::put('users/{id}', [UserApiController::class, 'update']); +Route::delete('users/{id}', [UserApiController::class, 'delete']); + +Route::get('roles', [RoleApiController::class, 'list']); +Route::post('roles', [RoleApiController::class, 'create']); +Route::get('roles/{id}', [RoleApiController::class, 'read']); +Route::put('roles/{id}', [RoleApiController::class, 'update']); +Route::delete('roles/{id}', [RoleApiController::class, 'delete']); + +Route::get('recycle-bin', [EntityControllers\RecycleBinApiController::class, 'list']); +Route::put('recycle-bin/{deletionId}', [EntityControllers\RecycleBinApiController::class, 'restore']); +Route::delete('recycle-bin/{deletionId}', [EntityControllers\RecycleBinApiController::class, 'destroy']); + +Route::get('content-permissions/{contentType}/{contentId}', [ContentPermissionApiController::class, 'read']); +Route::put('content-permissions/{contentType}/{contentId}', [ContentPermissionApiController::class, 'update']); + +Route::get('audit-log', [AuditLogApiController::class, 'list']);