Skip to content

Update routing testing with a concrete example of calling an API route #1502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marxjohnson wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update routing testing with a concrete example of calling an API route #1502

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/apis/subsystems/routing/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,3 +127,19 @@ All of these methods also accept:

- any headers to provide with your request
- any query parameters

As an example, to call the route `/api/rest/v2/question/bank/{course}/question_counts`, you would do the following:

```php title="Creating and processing a question_counts request"
public function test_question_counts(): void {
$this->resetAfterTest();
$course = self::getDataGenerator()->create_course();

$this->add_class_routes_to_route_loader(
\core_question\route\api::class,
\core\router\route_loader_interface::ROUTE_GROUP_API, // This is implied for routes in an `api` namespace, but must be set for other route groups.
);

$response = $this->process_api_request('GET', "/bank/{$course->id}/question_counts");
}
```