Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
Sample Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii
1. Useful Database Seeding . . . . . . . . . . . . . . . . . . . . . . . . 1
1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2 Introduction to Database Seeding . . . . . . . . . . . . . . . . 1
1.3 Building Seeders . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.4 That is about it . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.5 Secondary Data . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.6 When to run this? . . . . . . . . . . . . . . . . . . . . . . . . . 11
2. Planning and Creating Endpoints . . . . . . . . . . . . . . . . . . . 12
2.1 Functional Requirements . . . . . . . . . . . . . . . . . . . . . 12
2.2 Endpoint Theory . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.3 Planning Endpoints . . . . . . . . . . . . . . . . . . . . . . . . 21
3. Input and Output Theory . . . . . . . . . . . . . . . . . . . . . . . . 24
3.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.2 Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.3 Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.4 Supporting Formats . . . . . . . . . . . . . . . . . . . . . . . . 27
3.5 Content Structure . . . . . . . . . . . . . . . . . . . . . . . . . 32
4. Status Codes, Errors and Messages . . . . . . . . . . . . . . . . . . 38
4.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
4.2 HTTP Status Codes . . . . . . . . . . . . . . . . . . . . . . . . . 38
4.3 Error Codes and Error Messages . . . . . . . . . . . . . . . . . 40
4.4 Error or Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
4.5 Standards for Error Responses . . . . . . . . . . . . . . . . . . 43
