-
Notifications
You must be signed in to change notification settings - Fork 0
/
tyk_demo.postman_collection.json
2491 lines (2491 loc) · 94.1 KB
/
tyk_demo.postman_collection.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"info": {
"_postman_id": "47441dfa-69a6-4c47-afe6-5a3e3e0b4590",
"name": "Tyk Demo",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "API Definition",
"item": [
{
"name": "Middleware",
"item": [
{
"name": "Middleware - JavaScript",
"event": [
{
"listen": "test",
"script": {
"id": "bd7e1f22-3680-4f89-9ca3-4087e889ea96",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"Body data is set by middleware\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.data).to.eql(\"Request body set by pre middleware\");",
"});",
"",
"pm.test(\"'added' URL parameter is added by middleware \", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.args.added).to.eql(\"123\");",
"});",
"",
"pm.test(\"'Config-Data' header is added by middleware\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.headers['Config-Data']).to.eql(\"config-value\");",
"});",
"",
"pm.test(\"'Accepted' header is unchanged by middleware\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.headers['Accepted']).to.eql(\"789\");",
"});",
"",
"pm.test(\"Request is redirected by middleware\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.url).to.contain(\"/anything/post\");",
"});",
"",
"pm.test(\"'Deleted' header is deleted by middleware\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.headers['Deleted']).to.eql(undefined);",
"});",
"",
"pm.test(\"'User-Agent' header is set by middleware\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.headers['User-Agent']).to.eql(\"Tyk-JavaScript-Middleware\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Deleted",
"value": "deleted value",
"type": "text"
},
{
"key": "Accepted",
"value": "789",
"type": "text"
}
],
"url": {
"raw": "http://localhost:8080/javascript-middleware-api/post?deleted=deleted-value&accepted=456",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"javascript-middleware-api",
"post"
],
"query": [
{
"key": "deleted",
"value": "deleted-value"
},
{
"key": "accepted",
"value": "456"
}
]
},
"description": "Calls the `JavaScript Middleware API`, which executes two JavaScript middleware functions at the `pre` and `post` hooks.\n\nThe `pre` function does the following:\n- Writes to the API Gateway application log\n- Adds `User-Agent` header\n- Deletes `Deleted` header\n- Adds `added` URL parameter\n- Deletes `deleted` URL parameter\n- Changes the request body - see `data` property of response object\n- Changes the requested URL - see `url` property of response object\n\nThe `post` function does the following:\n- Writes to the API Gateway application log\n- Adds `config-data` header using value taken from API definition `config data`"
},
"response": []
}
],
"protocolProfileBehavior": {},
"_postman_isSubFolder": true
},
{
"name": "Endpoint Designer",
"item": [
{
"name": "Plugin - Mock Response",
"event": [
{
"listen": "test",
"script": {
"id": "84923368-e448-4a4c-b34b-97a905e46866",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"Mock response data is returned\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.mock).to.eql(\"response\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "x-api-version",
"value": "Default",
"type": "text"
}
],
"url": {
"raw": "http://localhost:8080/plugin-demo-api/anything/mock",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"anything",
"mock"
]
},
"description": "This request uses the `Mock Response` Endpoint Designer plugin to return a response directly from the Gateway when the API endpoint is called.\n\nThe mock response lets you define the headers and body of the response, as well as the HTTP status code returned. In this example the mock response is configured as follows:\n- Headers: Add a `Mock` header\n- Body: Add a basic JSON object as the body\n- HTTP status code: `200 OK`\n\nWhen the Mock Response is executed, the request does not reach the API Server, as the Gateway provides the response directly to the API Client."
},
"response": []
},
{
"name": "Plugin - Blacklist",
"event": [
{
"listen": "test",
"script": {
"id": "0b1dec21-146f-4125-b81d-8313d0bbbb31",
"exec": [
"pm.test(\"Status code is 403\", function () {",
" pm.response.to.have.status(403);",
"});",
"",
"pm.test(\"Error message is 'Requested endpoint is forbidden'\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.error).to.eql(\"Requested endpoint is forbidden\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "http://localhost:8080/plugin-demo-api/anything/blacklist",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"anything",
"blacklist"
]
},
"description": "The Blacklist plugin blocks requests, returning a `403 Forbidden` response."
},
"response": []
},
{
"name": "Plugin - Circuit Breaker",
"event": [
{
"listen": "test",
"script": {
"id": "0511586b-396e-441b-869a-f0a05ce635f4",
"exec": [
"pm.test(\"5th server error response triggers circuit breaker\", function () {",
" var circuitBreakerRequest = {",
" url: 'http://localhost:8080/plugin-demo-api/status/500',",
" method: 'GET'",
" };",
" ",
" pm.sendRequest(circuitBreakerRequest, function (err, response) {",
" pm.response.to.have.status(500);",
"",
" pm.sendRequest(circuitBreakerRequest, function (err, response) {",
" pm.response.to.have.status(500);",
" ",
" pm.sendRequest(circuitBreakerRequest, function (err, response) {",
" pm.response.to.have.status(500);",
" ",
" pm.sendRequest(circuitBreakerRequest, function (err, response) {",
" pm.response.to.have.status(500);",
"",
" pm.sendRequest(circuitBreakerRequest, function (err, response) {",
" pm.response.to.have.status(500);",
" });",
" });",
" });",
" });",
" });",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "http://localhost:8080/plugin-demo-api/status/500",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"status",
"500"
]
},
"description": "The Circuit Breaker can protect API servers by blocking requests for endpoints which are consistently returning errors.\n\nThe plugin monitors the responses from the API server for errors. If the API server returns over a certain number of errors over a particular number of requests then the API Gateway will stop proxing requests to it for a number of seconds. When the circuit breaker is activated, the API Gateway returns a `503 Service Unavailable` response.\n\nIn this example, the endpoint called by this request always returns `500 Server Error` responses, so will easily trigger the circuit breaker. The circuit breaker has been set up to sample 4 requests, and if over 50% of them result in errors then the circuit breaker will be active for 15 seconds."
},
"response": []
},
{
"name": "Plugin - Body Transform",
"event": [
{
"listen": "test",
"script": {
"id": "6bf2f11f-bd1e-4728-ae87-9e13f1e9d421",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"Body data transformed to JSON\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.json[\"Beijing_VPN\"]).to.eql(\"127.0.0.2\");",
" pm.expect(jsonData.json[\"Shanghai_VPN\"]).to.eql(\"127.0.0.1\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<servers version=\"1\">\n <server>\n <serverName>Shanghai_VPN</serverName>\n <serverIP>127.0.0.1</serverIP>\n </server>\n <server>\n <serverName>Beijing_VPN</serverName>\n <serverIP>127.0.0.2</serverIP>\n </server>\n</servers>"
},
"url": {
"raw": "http://localhost:8080/plugin-demo-api/anything/body-transform",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"anything",
"body-transform"
]
},
"description": "The Body Transform plugin can transform data in XML and JSON formats using templates. The output format can be anything, it depends entirely on the template. Transforms can be applied to both requests and responses.\n\nThis example applies a transform on the request, changing it from XML to JSON. You can see the request body is an XML document, but the response shows that the API server receive the data as JSON - you can verify this by checking the `data` and `json` properties of the response body."
},
"response": []
},
{
"name": "Plugin - Enforced Timeout (part 1)",
"event": [
{
"listen": "test",
"script": {
"id": "c5bbb502-12c9-4ad6-aff8-da16b20e2708",
"exec": [
"pm.test(\"Status code is 504\", function () {",
" pm.response.to.have.status(504);",
"});",
"",
"pm.test(\"Response time is more than 3 seconds\", function () {",
" pm.expect(pm.response.responseTime).to.be.above(3000);",
"});",
"",
"pm.test(\"Response time is less than 6 seconds\", function () {",
" pm.expect(pm.response.responseTime).to.be.below(6000);",
"});",
"",
"pm.test(\"Error message is 'Upstream service reached hard timeout.'\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.error).to.eql(\"Upstream service reached hard timeout.\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "http://localhost:8080/plugin-demo-api/delay/6",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"delay",
"6"
]
},
"description": "The Enforced Timeout plugin will return an error response from the Gateway if the API server does not respond within a set time. \n\nThis request calls the `/delay/6` endpoint, which has a 6 second delay before responding. The endpoint uses the Enforced Timeout plugin, which is configured for 4 seconds, so will repsond with a `504 Gateway Timeout` before the API server can provide a response."
},
"response": []
},
{
"name": "Plugin - Enforced Timeout (part 2)",
"event": [
{
"listen": "test",
"script": {
"id": "1e28bb3e-08d5-4bb1-b9fe-feb041fe15cc",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"Response time is more than 1 second\", function () {",
" pm.expect(pm.response.responseTime).to.be.above(1000);",
"});",
"",
"pm.test(\"Response time is less than 3 seconds\", function () {",
" pm.expect(pm.response.responseTime).to.be.below(3000);",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "http://localhost:8080/plugin-demo-api/delay/1",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"delay",
"1"
]
},
"description": "This endpoint has the same configuration at part 1, but because this endpoint only has a 1 second delay, it responds in time, so the API client receives the API server response and the Enforced Timeout is not activated."
},
"response": []
},
{
"name": "Plugin - URL Rewrite (part 1)",
"event": [
{
"listen": "test",
"script": {
"id": "905f35b8-e6d4-4dbb-9ac2-92ae685d54ea",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"URL rewritten to '/anything/default-rewrite'\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.url).to.contain(\"/anything/default-rewrite\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "http://localhost:8080/plugin-demo-api/anything/url-rewrite",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"anything",
"url-rewrite"
]
},
"description": "The URL Rewrite plugin can rewrite the URL based on many different parameters. This example shows the most basic version, using the default rewrite, which is used if none of the advanced rewrite rules are triggered. In this case, it rewrites to `/anything/default-rewrite` - check the `url` property in the response body to see the URL which was called on the API server.\n\nThe advanced rewriter can perform rewriting based on many aspects of a request:\n\n- URL query\n- Header\n- Path\n- Body\n- Session metadata\n- Context data\n\nSee the other parts of the URL Rewrite example for examples of the advanced URL rewriting rules."
},
"response": []
},
{
"name": "Plugin - URL Rewrite (part 2)",
"event": [
{
"listen": "test",
"script": {
"id": "8f522a28-7226-481c-81a8-c0a168799ea8",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"URL rewritten to '/anything/rewrite-query'\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.url).to.contain(\"/anything/rewrite-query\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "http://localhost:8080/plugin-demo-api/anything/url-rewrite?query=rewrite",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"anything",
"url-rewrite"
],
"query": [
{
"key": "query",
"value": "rewrite"
}
]
},
"description": "This example triggers an advanced URL rewrite rule based on the URL parameter. It checks for a parameter with the key `query` and value `rewrite`. The plugin rewrites to the URL `/anything/rewrite-query`."
},
"response": []
},
{
"name": "Plugin - URL Rewrite (part 3)",
"event": [
{
"listen": "test",
"script": {
"id": "44fbc060-6baf-4acd-b4f1-4d56f42e60a0",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"URL rewritten to '/anything/rewrite-header'\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.url).to.contain(\"/anything/rewrite-header\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Header",
"value": "rewrite",
"type": "text"
}
],
"url": {
"raw": "http://localhost:8080/plugin-demo-api/anything/url-rewrite",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"anything",
"url-rewrite"
]
},
"description": "This example triggers an advanced URL rewrite rule based on the request headers. It checks for a header with the key `Header` and value `rewrite`. The plugin rewrites to the URL `/anything/rewrite-header`."
},
"response": []
},
{
"name": "Plugin - Modify Headers",
"event": [
{
"listen": "test",
"script": {
"id": "138af158-72a6-4e2e-8e2f-3bbc93237dff",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"'New-Header' header is present\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.headers['New-Header']).to.eql(\"new-header-value\");",
"});",
"",
"pm.test(\"'Delete-Header' header not present\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.headers['Delete-Header']).to.eql(undefined);",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Delete-Header",
"value": "deleted-header-value",
"type": "text"
}
],
"url": {
"raw": "http://localhost:8080/plugin-demo-api/anything/modify-headers",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"anything",
"modify-headers"
]
},
"description": "This plugin can add and remove headers. In this example is adds a header called `New-Header` with the value `new-header-value`, and removes a header called `Delete-Header` which is sent in the request."
},
"response": []
},
{
"name": "Plugin - Cache",
"event": [
{
"listen": "test",
"script": {
"id": "f4bbd554-b792-43fe-8845-5c0a3180ba1a",
"exec": [
"var cacheRequest = {",
" url: 'http://localhost:8080/plugin-demo-api/uuid',",
" method: 'GET'",
"};",
"",
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"Response is same across two requests\", function() {",
" var response1;",
" var response2;",
" pm.sendRequest(cacheRequest, function (err, response) {",
" response1 =pm.response.json().uuid;",
" ",
" pm.sendRequest(cacheRequest, function (err, response) {",
" response2 =pm.response.json().uuid;",
" pm.expect(response1).to.eql(response2);",
" });",
" });",
"});",
"",
"pm.test(\"Cached response contains 'X-Tyk-Cached-Response' header set to '1'\", function() {",
" pm.sendRequest(cacheRequest, function (err, response) {",
" pm.sendRequest(cacheRequest, function (err, response) {",
" pm.expect(response.headers.get(\"X-Tyk-Cached-Response\")).to.eql(\"1\");",
" });",
" });",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "x-api-version",
"type": "text",
"value": "Default"
}
],
"url": {
"raw": "http://localhost:8080/plugin-demo-api/uuid",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"uuid"
]
},
"description": "This request uses the `Cache` Endpoint Designer plugin to return a cached response directly from the Gateway when the API endpoint is called.\n\n- Global Cache is enabled\n- Response from Upstream will be cached for 5 seconds\n\n\nWhen this API executed, the response from upstream API server will be cached and served for upto 5 seconds to the subsequest requests made to same Endpoint. If the Gateway returns a cached response then it will also a header `X-Tyk-Cached-Response` to the response with the value of `1`.\n\nThis plugin is defined in the Endpoint Designer of the API Definition. It is set to execute on requests for the `Default` version of the API only."
},
"response": []
},
{
"name": "Plugin - Ignore (part 1)",
"event": [
{
"listen": "test",
"script": {
"id": "cf9faaa8-d793-4ac1-bb15-d05a2d68b308",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "http://localhost:8080/basic-protected-api/anything/ignored",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"basic-protected-api",
"anything",
"ignored"
]
},
"description": "This request uses the **Ignore** Endpoint Designer plugin to access a protected API without providing any credentials. This API is configured to require the Client to authenticate using a token, with only the `/anything/ignored` path using the **Ignore** plugin. All other paths require authentication - see part 2.\n\nThe **Ignore** plugin instructs the Gateway to ignore the authentication settings defined in the API Definition. This allows API Clients to access ignored endpoints without providing any credentials. By default the plugin is case-sensitive, but can be configured to be case-insensitive when matching the path.\n\nThis plugin is useful in scenarios where there is a particular endpoint on the API Server that you would like to provide unauthenticated access to while keeping other endpoints protected. An authentication endpoint is a good example, where the Gateway will allow unauthenticated Clients to authenticate via the ignored endpoint, but require authentication for all other endpoints."
},
"response": []
},
{
"name": "Plugin - Ignore (part 2)",
"event": [
{
"listen": "test",
"script": {
"id": "d5adca40-9d4e-4072-9e4f-8c48173d344a",
"exec": [
"pm.test(\"Status code is 401\", function () {",
" pm.response.to.have.status(401);",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "http://localhost:8080/basic-protected-api/anything/not-ignored",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"basic-protected-api",
"anything",
"not-ignored"
]
},
"description": "This part of the **Ignore** Endpoint Designer plugin example shows that endpoints of this protected API cannot be accessed by authenticated clients.\n\nThe requested path `/anything/not-ignored` has no entry in the Endpoint Designer, so generates a `401 Unauthorized` response to unauthenticated clients."
},
"response": []
},
{
"name": "Plugin - Validate JSON (part 1)",
"event": [
{
"listen": "test",
"script": {
"id": "22cd7a49-318b-4bb3-8dfb-864d1b3657f8",
"exec": [
"pm.test(\"Status code is 422\", function () {",
" pm.response.to.have.status(422);",
"});",
"",
"pm.test(\"Error message is 'firstName: firstName is required'\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.error).to.eql(\"firstName: firstName is required\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n\t\"lastName\": \"Hoskins\",\n\t\"age\": 71\n}"
},
"url": {
"raw": "http://localhost:8080/plugin-demo-api/anything/validate-json",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"anything",
"validate-json"
]
},
"description": "The Validate JSON plugin will validate the JSON in the request body against a JSON scheme defined in the plugin configuration. If the request fails validation then the API Gateway returns a `422 Unprocessable Entity` HTTP status and a detailed description of the problem in the response body.\n\nFor this example, the JSON sent in the request body did not include a `firstName` property, so the request is rejected with a response specifically referencing the missing property.\n\nFor reference, the JSON schema used in this example:\n\n```\n{\n \"title\": \"Person\",\n \"type\": \"object\",\n \"properties\": {\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": \"string\"\n },\n \"age\": {\n \"description\": \"Age in years\",\n \"type\": \"integer\",\n \"minimum\": 0\n }\n },\n \"required\": [\"firstName\", \"lastName\"]\n}\n```"
},
"response": []
},
{
"name": "Plugin - Validate JSON (part 2)",
"event": [
{
"listen": "test",
"script": {
"id": "bcd24369-a412-4b10-84bb-340e586ac511",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"Valid JSON data sent\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.json.age).to.eql(71);",
" pm.expect(jsonData.json.firstName).to.eql(\"Bob\");",
" pm.expect(jsonData.json.lastName).to.eql(\"Hoskins\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n\t\"firstName\": \"Bob\",\n\t\"lastName\": \"Hoskins\",\n\t\"age\": 71\n}"
},
"url": {
"raw": "http://localhost:8080/plugin-demo-api/anything/validate-json",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"anything",
"validate-json"
]
},
"description": "This example sends a valid payload, so is accepted and a normal response is received from the API server."
},
"response": []
},
{
"name": "Plugin - Request Size Limit (part 1)",
"event": [
{
"listen": "test",
"script": {
"id": "adb5f443-8afa-487d-b7e6-d95ab57c0e08",
"exec": [
"pm.test(\"Status code is 400\", function () {",
" pm.response.to.have.status(400);",
"});",
"",
"pm.test(\"Error message is 'Request is too large'\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.error).to.eql(\"Request is too large\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "1234567890"
},
"url": {
"raw": "http://localhost:8080/plugin-demo-api/anything/request-size-limit",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"anything",
"request-size-limit"
]
},
"description": "The Request Size Limit Plugin validates the size of the request body against defined maximum size in byte.\n\nIn this example, the plugin is configured to only allow requests with a maximum payload size of 9 bytes. The request sends a body with 10 bytes, so is rejected with a `400 Bad Request` response."
},
"response": []
},
{
"name": "Plugin - Request Size Limit (part 2)",
"event": [
{
"listen": "test",
"script": {
"id": "50caea29-d4c2-4c8f-8c6b-4fde1305f342",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"Request body is 9 bytes\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.data).to.eql(\"123456789\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "123456789"
},
"url": {
"raw": "http://localhost:8080/plugin-demo-api/anything/request-size-limit",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"anything",
"request-size-limit"
]
},
"description": "This example succeeds because the request is 9 bytes, which the same as the configured maximum value in the plugin."
},
"response": []
},
{
"name": "Plugin - Method Transform",
"event": [
{
"listen": "test",
"script": {
"id": "e7c74988-3893-4639-8ade-5e41804396a9",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"Request method is changed to POST\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.method).to.eql(\"POST\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "PUT",
"header": [],
"url": {
"raw": "http://localhost:8080/plugin-demo-api/anything/method-transform",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"anything",
"method-transform"
]
},
"description": "The Method Transform plugin changes the HTTP method used in the request. In this example, it changes the PUT method to a POST. Check the `method` property in the response body to see the method used."
},
"response": []
},
{
"name": "Plugin - Track Endpoint",
"event": [
{
"listen": "test",
"script": {
"id": "9d623292-47bb-4486-813f-7c1274a852dc",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "http://localhost:8080/plugin-demo-api/anything/track-endpoint",
"protocol": "http",
"host": [
"localhost"
],
"port": "8080",
"path": [
"plugin-demo-api",
"anything",
"track-endpoint"
]
},
"description": "The Track Endpoint plugin will record analytics about the number of times this individual endpoint has been requested. The analytics for this are visible in the Endpoint Popularity report in the Dashboard."
},
"response": []
},
{
"name": "Plugin - Global Version Settings",
"event": [
{
"listen": "test",
"script": {
"id": "d09b4394-551f-47fa-b951-4d59aa235de1",
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"'Global-Add' header added to request\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.headers['Global-Add']).to.eql(\"global-value\");",
"});"
],
"type": "text/javascript"