Download to read offline
Uploaded byMichael Peacock
Test driven APIs with Laravel
This document summarizes a presentation about testing APIs built with Laravel. It discusses testing API concepts in Laravel, including testing models, database interactions, HTTP requests, responses, and validation. It provides examples of building an API for user groups, events, and venues using Laravel resources, requests, and testing methods like assertStatus and assertJson. The goal is to gradually build out the API with tests to ensure functionality without using an API client.
More Related Content
Similar to Test driven APIs with Laravel
Test driven APIs with Laravel
- 1. Test Driven APIswith Laravel @michaelpeacock
- 2. What’s in store? •Look at API concepts within Laravel • Look at testing concepts within Laravel • How we can gradually build an API with confidence in its functionality, without ever opening an API client
- 3. @michaelpeacock • Organiser ofPHP North East • Occasional author and speaker • Freelance developer • Consultant CTO for early stage SaaS start-ups
- 4.
- 5. Lots for free •Models & Collections > JSON Responses automatically • Validation Failures > JSON Responses automatically • Automatic handling of request and response headers (content-type, etc)
- 6. Lots to ofpower to customise • API Resources • API Routing • Resource Controllers • API Resource Controllers
- 7.
- 8. Database interaction • RefreshDatabase:calls migrate:fresh (drops all tables and re-migrates) • DatabaseTransactions: wraps test db calls in a transaction
- 9.
- 10. Sample project • APIfor user group • Events • Venues • Talks
- 11.
- 12. Model integration tests •A good starting point • Give us confidence that models, migrations, relations and factories are setup correctly • Especially important if we are providing custom field names for relations, or working with models outside of the root app directory • Factories are important for API tests, so its good that we test the basis setup before we move onto that. • Inspired by Amo Chohan: 12 tried and tested top tips for better testing
- 13. Key things totest initially • We can instantiate the class • Any relations
- 18.
- 19. Tip: Name yourmigrations well
- 21.
- 22.
- 24.
- 25. Making requests • $this->json(method,uri, data, headers) • $this->getJson / postJson / patchJson / deleteJson • $this->get(url, headers) • $this->post(url, data, headers)
- 26. Testing responses: StatusCodes • $response->assertStatus(status code) • $response->assertSuccessful() • $response->assertOk() • $response->assertNotFound() • $response->assertNotFound() • $response->assertForbidden()
- 27.
- 29. API Controllers php artisanmake:controller Api/EventsController --model=Event --api
- 30.
- 33. Testing response data •$response->assertExactJson(array) • $response->assertJson(array) • $response->assertJsonCount(array) • $response->assertJsonFragment(array) • $response->assertJsonMissing(array) • $response->assertJsonMissingExact(array) • $response->assertJsonStructure(array)
- 34. Testing headers • $response->assertHeader(header,value) • $response->assertHeaderMissing(header) • $response->assertLocation(url) // Location header
- 35. Lets check weget a JSON response…
- 40. Better responses • Venuename and description should be included • Event id should not be included • Start and end date should be formatted a specific way
- 45. Now we getsome failing (not erroring) tests
- 46. Resources php artisan make:resourceEvent php artisan make:resource Venue
- 49.
- 50. POST /events • Wenow want to test creating an event
- 51. A test helperto build valid request data
- 54. Saving a newevent
- 55. Status codes andResources
- 57. Testing Validation • $response->assertJsonMissingValidationErrors(array) •$response->assertJsonValidationErrors()
- 59. Creating a newrequest php artisan make:request CreateEventRequest
- 61.
- 63.
- 64.
- 65.
Editor's Notes
- #8 Support for unit, browser, HTTP, console tests.
- #10 Discuss how these work, and the impact on database transactions (i.e. how that works)
- #16 Explain about the relationships first, putting thought into the modelling of the app. Emphasise how many times I've been caught out by a migration where it was linked to the wrong FK because I copy and pasted a migration!
- #23 We can then iterate between tests and code, adding in the relationships that we need, until we get passing tests.
- #38 Returning a collection or a model, combined with API request headers, results in the data being converted to JSON
- #39 By default the JSON response includes all fields in the model, we can test that we have some fields that we want
- #45 Error: date fields are not cast as dates, fix that, then get failing tests.
- #47 Resources: transformers for our eloquent models
- #54 Failing test because nothing is created, its an error not a fail as such because we called findOrFail, in our test, so our test has thrown an exception