X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/a6633642232efd164d4708967ab59e498fbff896..refs/heads/development:/routes/api.php diff --git a/routes/api.php b/routes/api.php index 44643d6d4..85e872ba4 100644 --- a/routes/api.php +++ b/routes/api.php @@ -3,44 +3,95 @@ /** * Routes for the BookStack API. * Routes have a uri prefix of /api/. - * Controllers are all within app/Http/Controllers/Api + * Controllers all end with "ApiController" */ -Route::get('docs', 'ApiDocsController@display'); -Route::get('docs.json', 'ApiDocsController@json'); - -Route::get('books', 'BookApiController@list'); -Route::post('books', 'BookApiController@create'); -Route::get('books/{id}', 'BookApiController@read'); -Route::put('books/{id}', 'BookApiController@update'); -Route::delete('books/{id}', 'BookApiController@delete'); - -Route::get('books/{id}/export/html', 'BookExportApiController@exportHtml'); -Route::get('books/{id}/export/pdf', 'BookExportApiController@exportPdf'); -Route::get('books/{id}/export/plaintext', 'BookExportApiController@exportPlainText'); - -Route::get('chapters', 'ChapterApiController@list'); -Route::post('chapters', 'ChapterApiController@create'); -Route::get('chapters/{id}', 'ChapterApiController@read'); -Route::put('chapters/{id}', 'ChapterApiController@update'); -Route::delete('chapters/{id}', 'ChapterApiController@delete'); - -Route::get('chapters/{id}/export/html', 'ChapterExportApiController@exportHtml'); -Route::get('chapters/{id}/export/pdf', 'ChapterExportApiController@exportPdf'); -Route::get('chapters/{id}/export/plaintext', 'ChapterExportApiController@exportPlainText'); - -Route::get('pages', 'PageApiController@list'); -Route::post('pages', 'PageApiController@create'); -Route::get('pages/{id}', 'PageApiController@read'); -Route::put('pages/{id}', 'PageApiController@update'); -Route::delete('pages/{id}', 'PageApiController@delete'); - -Route::get('pages/{id}/export/html', 'PageExportApiController@exportHtml'); -Route::get('pages/{id}/export/pdf', 'PageExportApiController@exportPdf'); -Route::get('pages/{id}/export/plaintext', 'PageExportApiController@exportPlainText'); - -Route::get('shelves', 'BookshelfApiController@list'); -Route::post('shelves', 'BookshelfApiController@create'); -Route::get('shelves/{id}', 'BookshelfApiController@read'); -Route::put('shelves/{id}', 'BookshelfApiController@update'); -Route::delete('shelves/{id}', 'BookshelfApiController@delete'); +use BookStack\Activity\Controllers\AuditLogApiController; +use BookStack\Api\ApiDocsController; +use BookStack\App\SystemApiController; +use BookStack\Entities\Controllers as EntityControllers; +use BookStack\Exports\Controllers as ExportControllers; +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; + +Route::get('docs.json', [ApiDocsController::class, 'json']); + +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', [ExportControllers\BookExportApiController::class, 'exportHtml']); +Route::get('books/{id}/export/pdf', [ExportControllers\BookExportApiController::class, 'exportPdf']); +Route::get('books/{id}/export/plaintext', [ExportControllers\BookExportApiController::class, 'exportPlainText']); +Route::get('books/{id}/export/markdown', [ExportControllers\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', [ExportControllers\ChapterExportApiController::class, 'exportHtml']); +Route::get('chapters/{id}/export/pdf', [ExportControllers\ChapterExportApiController::class, 'exportPdf']); +Route::get('chapters/{id}/export/plaintext', [ExportControllers\ChapterExportApiController::class, 'exportPlainText']); +Route::get('chapters/{id}/export/markdown', [ExportControllers\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', [ExportControllers\PageExportApiController::class, 'exportHtml']); +Route::get('pages/{id}/export/pdf', [ExportControllers\PageExportApiController::class, 'exportPdf']); +Route::get('pages/{id}/export/plaintext', [ExportControllers\PageExportApiController::class, 'exportPlainText']); +Route::get('pages/{id}/export/markdown', [ExportControllers\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']); + +Route::get('system', [SystemApiController::class, 'read']);