forked from kontur-web-courses/web-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathweb-api-legacy.html
1108 lines (774 loc) · 32.8 KB
/
web-api-legacy.html
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
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
<link rel="stylesheet" href="reveal/css/reveal.css">
<link rel="stylesheet" href="reveal/css/theme/kontur-light.css" id="theme">
<!-- Theme used for syntax highlighting of code -->
<link rel="stylesheet" href="reveal/css/highlight/idea-for-light.css">
<link rel="stylesheet" href="reveal/css/highlight/darkula-for-dark.css">
<!--[if lt IE 9]>
<script src="reveal/js/html5shiv.js"></script>
<![endif]-->
<script defer src="reveal/js/head.min.js"></script>
<script defer src="reveal/js/reveal.js"></script>
<script defer src="reveal/initialize.js"></script>
<script defer src="reveal/js/d3.min.js"></script>
<style>
.slides .center {
text-align: center;
}
.slides .right {
text-align: right;
}
</style>
<title>Web API</title>
</head>
<body>
<div class="reveal"><div class="slides">
<section data-markdown><script type="text/template">
# Web API
<p class="center"><a href="https://github.com/kontur-web-courses/web-api">https://github.com/kontur-web-courses/<b>web-api</b></a></p>
</script></section>
<section data-markdown><script type="text/template">
## Про хорошие API
***
### Зачем создавать API?
***
### Бэкенд для SPA
<p><img src="assets/frontandback.png" width="300"></p>
*Только ли?*
***
### Потребности в API
- Одинаковые возможности в разных типах приложений
*Web, Mobile, Desktop*
- Переиспользование API в продуктах компании
*Сервис аутентификации, биллинг, сервис адресов*
- API для внешних заказчиков
*Интеграции с банками*
- Автоматизация с помощью ботов
*Боты для трейдинга, группы ulearn*
***
### А какое API хорошее?
***
### Особенности хорошего API
1. Его **легко изучать**!
- Устроено стандартным, предсказуемым образом
- Понятно сообщает об ошибках
- Гранулярно: разбито на небольшие переиспользуемые кусочки
- Подсказывает доступную функциональность
- Документировано
2. Ему **можно доверять**!
- Стабильное, хотя допустимо расширение возможностей
- Версионирование при несовместимых изменениях
***
### Наша цель — понятное API
</script></section>
<section data-markdown><script type="text/template">
## HTTP API
***
### Получение данных
Запрос
```http
GET /documents/19?page=20¬es=1 HTTP/1.1
Host: example.com
Accept: text/html
```
Ответ
```http
HTTP/1.1 200 OK
Content-Type: text/html; charset=utf-8
Content-Length: 1234
<!-- ДОКУМЕНТ -->
```
***
### Отправка данных
Запрос
```http
POST /messagebox HTTP/1.1
Host: example.com
Accept: application/json, application/xml
X-Session: 5CA17001-04C5-4BA8-A05B-0F08FA9E4465
Content-Type: application/json
Content-Length: 456
{"msg":"Hi, people!","from": ... }
```
Ответ
```http
HTTP/1.1 204 No Content
```
***
### Способы передачи данных в HTTP
- Method: `GET`, `POST`
- Path: `/documents/19`, `/messagebox`
- Query string: `page=20¬es=1`
- Headers: `X-Session`
- Body: `{"msg":"Hi, people!","from": ... }`
**Что и для чего использовать в API?**
***
### Рассмотрим API для конкретной задачи
Я хочу записаться на прием к врачу.
От веб службы мне нужно получить свободные часы приема на конкретную дату и после записаться на прием.
***
### Вся инфомация в теле запроса
```http
POST /appointmentService HTTP/1.1
[various other headers]
<openSlotRequest date = "2010-01-04" doctor = "mjones"/>
```
```http
HTTP/1.1 200 OK
[various headers]
<openSlotList>
<slot start = "1400" end = "1450">
<doctor id = "mjones"/>
</slot>
<slot start = "1600" end = "1650">
<doctor id = "mjones"/>
</slot>
</openSlotList>
```
***
### Уровень 0. The Swamp of POX
- Все методы собраны в кучу
- Сложно понять, какие есть сущности
- Сложно понять, какие доступны действия
*POX* — Plain Old Xml
*XML-RPC* — стандарт API, соответствующий уровню 0
***
### Как сделать HTTP API лучше?
***
### Сделаем разные пути у сущностей
```http
POST /doctors/mjones HTTP/1.1
[various other headers]
<openSlotRequest date = "2010-01-04"/>
```
```http
HTTP/1.1 200 OK
[various headers]
<openSlotList>
<slot id = "1234" doctor = "mjones" start = "1400" end = "1450"/>
<slot id = "5678" doctor = "mjones" start = "1600" end = "1650"/>
</openSlotList>
```
***
```http
POST /slots/1234 HTTP/1.1
[various other headers]
<appointmentRequest>
<patient id = "jsmith"/>
</appointmentRequest>
```
```http
HTTP/1.1 200 OK
[various headers]
<appointment>
<slot id = "1234" doctor = "mjones" start = "1400" end = "1450"/>
<patient id = "jsmith"/>
</appointment>
```
***
### Уровень 1. Resourses
- Иерархия сущностей представлена путями в URI
- Поэтому к каждой сущности можно обращаться отдельно,
а значит каждая сущность — независимый ресурс
- API разделяется на части, сложность каждой части уменьшается
***
### Представления ресурсов
Ресурс может быть представлен в разных видах: JSON, XML,
Excel, XHTML и т.д.
Говорят, у **одного ресурса есть несколько представлений**
Необходимое представление можно запросить через
`Content Negotiation`
***
### Content Negotiation
В запросе должен быть заголовок `Accept`
```http
GET /documents/19?page=20¬es=1 HTTP/1.1
Accept: application/json, application/xml
```
Сервер попытается ответить запрошенным представлением ресурса
```http
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1234
```
[Подробнее](https://developer.mozilla.org/ru/docs/Web/HTTP/Content_negotiation)
***
### Media Types
```txt
text/plain
text/html
text/css
application/json
application/xml
image/gif
image/svg+xml
application/xhtml+xml
application/vnd.ms-excel
application/vnd.mozilla.xul+xml
```
vnd. — префикс для типов от компаний
+xml — передается посредством XML
***
### Как сделать HTTP API лучше?
***
### Используем Methods
```http
GET /doctors/mjones/slots?date=20100104&status=open HTTP/1.1
[various headers]
```
```http
HTTP/1.1 200 OK
[various headers]
<openSlotList>
<slot id = "1234" doctor = "mjones" start = "1400" end = "1450"/>
<slot id = "5678" doctor = "mjones" start = "1600" end = "1650"/>
</openSlotList>
```
Используется GET для неизменяющего запроса
***
### Используем Status codes
```http
POST /slots/1234 HTTP/1.1
[various other headers]
<appointmentRequest>
<patient id = "jsmith"/>
</appointmentRequest>
```
```http
HTTP/1.1 201 Created
Location: slots/1234/appointment
[various headers]
<appointment>
<slot id = "1234" doctor = "mjones" start = "1400" end = "1450"/>
<patient id = "jsmith"/>
</appointment>
```
Location содержит путь до созданного ресурса
***
```http
POST /slots/1234 HTTP/1.1
[various other headers]
<appointmentRequest>
<patient id = "jsmith"/>
</appointmentRequest>
```
```https
HTTP/1.1 409 Conflict
[various headers]
<openSlotList>
<slot id = "5678" doctor = "mjones" start = "1600" end = "1650"/>
</openSlotList>
```
Тело содержит свободный слот
***
### Уровень 2. HTTP Verbs
- Стандартные методы и коды ошибок уменьшяют вариативность, уменьшая сложность API
- Ответы содержат информацию о возможных действиях
***
### Какие бывают действия
**Methods**: `GET`, `POST`, `DELETE`, `PUT`, `PATCH`, `HEAD`, `OPTIONS`
**Безопасные** действия: не вносят изменений
**Идемпотентные** действия: повторый вызов не меняет результат
***
### Таблица действий
| Method | Действие | Безоп. | Идемпот. |
|--------- |------------------------------ |-------- |---------- |
| GET | Получение ресурса | | |
| POST | Добавление ресурса | | |
| DELETE | Удаление ресурса | | |
| PUT | Полное обновление ресурса | | |
| PATCH | Частичное обновление ресурса | | |
| HEAD | Метаинформация о ресурсе | | |
| OPTIONS | Возможные действия | | |
*Какие безопасные?*
***
### Таблица действий
| Method | Действие | Безоп. | Идемпот. |
|--------- |------------------------------ |-------- |---------- |
| GET | Получение ресурса | Да | |
| POST | Добавление ресурса | Нет | |
| DELETE | Удаление ресурса | Нет | |
| PUT | Полное обновление ресурса | Нет | |
| PATCH | Частичное обновление ресурса | Нет | |
| HEAD | Метаинформация о ресурсе | Да | |
| OPTIONS | Возможные действия | Да | |
*Какие идемпотентные?*
***
### Таблица действий
| Method | Действие | Безоп. | Идемпот. |
|--------- |------------------------------ |-------- |---------- |
| GET | Получение ресурса | **Да** | Да |
| POST | Добавление ресурса | Нет | **Нет** |
| DELETE | Удаление ресурса | Нет | **Да** |
| PUT | Полное обновление ресурса | Нет | **Да** |
| PATCH | Частичное обновление ресурса | Нет | **Нет** |
| HEAD | Метаинформация о ресурсе | **Да** | Да |
| OPTIONS | Возможные действия | **Да** | Да |
***
### Коды ответов для API
1xx: Informational
2xx: **Successful** - возвращаются в случае успеха
3xx: Redirection
4xx: **Client Error** - возвращаются при ошибках
5xx: Server Error
***
| Код | Фраза | Применение |
|------ |---------------------- |----------------------------------------------------------------------- |
| 200 | OK | Запрос выполнен, ответ с содержимым |
| 201 | Created | Ресурс создан, ответ обычно содержит ссылки на созданный ресурс |
| 204 | No Content | Запрос выполнен, ответ без содержимого |
***
| Код | Фраза | Применение |
|------ |----------------------------- |----------------------------------------------------------------------- |
| 400 | Bad Request | Ошибка в запросе клиента |
| 404 | Not Found | Ресурс не найден |
| 405 | Method Not Allowed | Метод не доступен, должны возвращаться доступные методы |
| 406 | Not Acceptable | Ресурс не может быть представлен в запрошенном виде |
| 409 | Conflict | Конфликт с текущем состоянием ресурса, часто из-за обновления |
| 422 | Unprocessable Entity | Не пройдены логические проверки |
***
### Как сделать HTTP API лучше?
***
### Добавим ссылки на возможные действия
```http
GET /doctors/mjones/slots?date=20100104&status=open HTTP/1.1
[various headers]
```
```http
HTTP/1.1 200 OK
[various headers]
<openSlotList>
<slot id = "1234" doctor = "mjones" start = "1400" end = "1450">
<link rel = "/linkrels/slot/book"
uri = "/slots/1234"/>
</slot>
<slot id = "5678" doctor = "mjones" start = "1600" end = "1650">
<link rel = "/linkrels/slot/book"
uri = "/slots/5678"/>
</slot>
</openSlotList>
```
***
```http
POST /slots/1234 HTTP/1.1
[various other headers]
<appointmentRequest>
<patient id = "jsmith"/>
</appointmentRequest>
```
```http
HTTP/1.1 201 Created
Location: http://royalhope.nhs.uk/slots/1234/appointment
[various headers]
<appointment>
<slot id = "1234" doctor = "mjones" start = "1400" end = "1450"/>
<patient id = "jsmith"/>
<link rel = "/linkrels/appointment/cancel"
uri = "/slots/1234/appointment"/>
<link rel = "self"
uri = "/slots/1234/appointment"/>
<link rel = "/linkrels/appointment/changeTime"
uri = "/doctors/mjones/slots?date=20100104&status=open"/>
</appointment>
```
***
### Уровень 3. Hypermedia Controls
- В телах ответов содержатся ссылки на возможные действия, упрощая исследование API
- API становится похоже на конечный автомат, где после каждого запроса доступно некоторое количество переходов
***
### Следующий уровень API =D
<p><img src="assets/bot.png" width="400"></p>
***
### Richardson Maturity Model
Классифицирует HTTP API
- Уровень 0. The Swamp of POX
- Уровень 1. Resourses
- Уровень 2. HTTP Verbs
- Уровень 3. Hypermedia Controls
[Подробнее](https://martinfowler.com/articles/richardsonMaturityModel.html)
***
### HTTP Verbs — гигиенический минимум
</script></section>
<section data-markdown><script type="text/template">
## Инструменты разработки API
***
### Создание Web API для .NET Core
```bash
dotnet new webapi -n ValuesApi
```
***
### Program.cs
```cs
public class Program
{
public static void Main(string[] args)
{
CreateWebHostBuilder(args).Build().Run();
}
public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
WebHost.CreateDefaultBuilder(args)
.UseStartup<Startup>();
}
```
***
### Startup.cs
```cs
public class Startup
{
// Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc().SetCompatibilityVersion(...);
}
// Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseHttpsRedirection();
app.UseMvc();
}
}
```
***
### ValuesController.cs
```cs
[Route("api/[controller]")]
[ApiController]
public class ValuesController : ControllerBase
{
[HttpGet] // GET api/values
public ActionResult<IEnumerable<string>> Get() => new[] {"value1", "value2"};
[HttpGet("{id}")] // GET api/values/5
public ActionResult<string> Get(int id) => "value";
[HttpPost] // POST api/values
public void Post([FromBody] string value) { }
}
```
***
### Атрибуты MVC
**Управление путями**
`[Route("api/[controller]")]`, `[HttpGet("{id}")]`
**Управление методами**
`[HttpGet]`, `[HttpPost]`, `[HttpDelete]`
`[HttpPut]`, `[HttpPatch]`,
`[HttpHead]`, `[HttpOptions]`,
**Управление источником данных**
`[FromHeader]`, `[FromQuery]`, `[FromRoute]`,
`[FromForm]`, `[FromBody]`, можно дописать свои
***
### Запуск Web API
```bash
dotnet run -p ValuesApi
```
https://localhost:5001/api/values
http://localhost:5000/api/values
***
### Демо Postman
1. Import / Import File
Из `/WebApi/Samples/ValuesApi.postman_collection.json`
2. File / Settings / General / SSL certificate verification
*Установить в OFF*
3. Collections / ValuesApi / Выбрать ... / Edit / Variables / baseUrl
*Записать адрес, где развернуто приложение*
4. Collections / ValuesApi / Открыть любой запрос
*Запустить*: увидеть статус код, тело, результаты тестов
*Найти*: Params, Headers, Body, Pre-request Script, Tests
5. Runner / Collection Runner / ValuesApi / Run ValuesApi
*Посмотреть результат прохождения тестов*
6. Console
*Показать, что можно смотреть информацию по запросам*
***
### Postman — UI для бэкендера
</script></section>
<section data-markdown><script type="text/template">
## Коллекция ресурсов
***
### Ресурсы, а не функции
Большинство действий можно рассматривать
как создание и изменение ресурсов
Вместо
`POST /reserveBook?bookId=5`
Использовать
`PUT /books/5/reservation`
В результате:
- API делится на кусочки
- Действия сводятся к CRUD над ресурсами,
представимыми методами HTTP
- Легко понять API, зная его URI и HTTP-методы
***
### Тренировка. Что делают вызовы API?
<span class="fragment">`GET /users/5`</span>
<span class="fragment">`POST /users`</span>
<span class="fragment">`DELETE /users/6`</span>
<span class="fragment">`PUT /users/2`</span>
<span class="fragment">`PUT /users/100500`</span>
<span class="fragment">`PATCH /users/3`</span>
<span class="fragment">`GET /users`</span>
<span class="fragment">`GET /users?pageNumber=5&pageSize=100`</span>
<span class="fragment">`OPTIONS /users`</span>
<span class="fragment">`OPTIONS /users/6`</span>
<span class="fragment">`HEAD /users/5`</span>
***
### Нюанс. Именование коллекции
<span class="fragment">Как правильно `PUT /users/4` или `PUT /user/4`?</span>
<ul><li class="fragment">Верны оба варианта. Но важно, чтобы везде в API был один стиль
Так как в любом случае `GET /users`,
то `PUT /users/4` более единообразен</li></ul>
***
### Нюанс. Запросы-функции
<span class="fragment">
Можно ли использовать функции или только ресурсы?
Например, `POST /books/5/reserve`
</span>
<ul><li class="fragment">Можно, если выражение идеи через ресурсы
сделает API менее понятным</li></ul>
<span class="fragment">
Какой код ответа в случае успеха?
</span>
<ul><li class="fragment">Часто `200 OK` или `204 No Content`,
потому что выполняется функция, а не создается ресурс</li></ul>
<ul><li class="fragment">В случае `200 OK` возвращается релевантная запросу информация</li></ul>
***
### Паттерн Repository
```cs
interface IUserRepository
{
UserEntity Insert(UserEntity user);
UserEntity FindById(Guid id);
UserEntity GetOrCreateByLogin(string login);
void Update(UserEntity user);
UserEntity UpdateOrInsert(UserEntity user);
void Delete(Guid id);
}
```
- Позволяет скрыть особенности хранения данных за абстракцией
- Можно разрабатывать и тестировать API отдельно от БД
- Каждому тип сущностей — отдельный репозиторий
- Содержит все нужные и допустимые методы
***
### Data Transfer Object
**Простой объект для передачи данных**,
не содержит методов и логики
Если API принимает или возвращает объекты
в виде XML, JSON или других форматах, то это DTO
**Полезно создавать отдельные DTO** для каждого метода API,
потому что набор полей или правил проверки
отличается от метода к методу
***
### Именование DTO
**Примеры названий для GET**
- UserDto
- UserToGetDto, UserToGet
**Примеры названий для POST**
- UserForCreationDto, UserForCreation
- UserToCreateDto, UserToCreate
- UserToPostDto, UserToPost
И многие другие варианты...
***
### Задача UsersApi
</script></section>
<section data-markdown><script type="text/template">
## Документация API
***
### Проблема
Чтобы использовать API, надо его узнать!
<div class="fragment">Значит кто-то должен описать.</div>
<div class="fragment">
Если API описывает аналитик/разработчик:
<ul><li>Ошибки и неточности<li>Сложно описать все<li>Нестандартно, как получится</ul>
</div>
***
### Стандарт описания API — решение
**Swagger 2.0** или **OpenApi 3.0** от SmartBear
Можно описывать API на yaml или json
***
### Демо Swagger
Для использования Swagger в .NET есть библиотека **Swashbuckle**
Чтобы воспользоваться, надо подключить к `Startup.cs`
методы из `/WebApi/Samples/SwaggerExtensions.cs`
В результате:
- Появится визуализация API при старте WebApi
- UI можно использовать для отправки запросов
- Реальное описание доступно по адресу в виде JSON
`/swagger/web-api/swagger.json`
- `swagger.json` можно редактировать в https://editor.swagger.io
- Содержимое `swagger.json` можно импортировать в Postman
***
<h3 class="center">Даже автосгенерированный Swagger значительно облегчает жизнь фронтендеру!</h3>
***
### Дополнительные источники документации
- Аннотации из ASP.NET Core
- Xml Documentation Comments
- Swashbuckle Annotations
***
### Аннотации из ASP.NET Core
```cs
[HttpGet("{userId}")]
[Produces("application/json", "application/xml")]
ActionResult<UserDto> GetUserById([FromRoute] Guid userId) { /*...*/ }
```
***
### Xml Documentation Comments
```cs
/// <summary>
/// Получить пользователя
/// </summary>
/// <param name="userId">Идентификатор пользователя</param>
ActionResult<UserDto> GetUserById([FromRoute] Guid userId) { /*...*/ }
```
***
### Swashbuckle Annotations
```cs
[SwaggerResponse(200, "OK", typeof(UserDto))]
[SwaggerResponse(404, "Пользователь не найден")]
ActionResult<UserDto> GetUserById([FromRoute] Guid userId) { /*...*/ }
```
***
### Описание без Swashbuckle Annotations
```cs
/// <summary>
/// Получить пользователей
/// </summary>
/// <param name="pageNumber">Номер страницы, по умолчанию 1</param>
/// <param name="pageSize">Размер страницы, по умолчанию 20</param>
/// <response code="200">OK</response>
[HttpGet(Name = nameof(GetUsers))]
[Produces("application/json", "application/xml")]
[ProducesResponseType(typeof(IEnumerable<UserDto>), 200)]
IActionResult GetUsers(int pageNumber, int pageSize) { /*...*/ }
```
**Приходится описывать code у response в двух местах :(**
***
### Описание Media Type для PATCH
```cs
[HttpPatch("{userId}")]
[Consumes("application/json-patch+json")]
[Produces("application/json", "application/xml")]
IActionResult PartiallyUpdateUser([FromRoute] Guid userId,
[FromBody] JsonPatchDocument<object> patchDoc) { /*...*/ }
```
***
### Демо Описания для Swagger
Скопировать в `UsersController` описания из
`/WebApi/Samples/ISwaggerDescriptionsForUsersController.cs`
***
### Результат использования Swagger
- **Автогенерация описания** по коду сервера
- Стандартная и понятная **визуализация API**
- **Песочница**, чтобы делать запросы: встроенная и Postman
- **Автогенерация клиентов и серверов** по описанию
</script></section>
<section data-markdown><script type="text/template">
## REST
***
### Representational State Transfer
**REST** дает представление о том, как ведет себя
хорошо спроектированное веб-приложение:
- Сеть веб-страниц (*виртуальный конечный автомат*),
- где пользователь взаимодействует с приложением,
выбирая ссылки (*переходы между состояниями*)
- в результате чего следующая страница передается пользователю
(*следующее состояние приложения*)
Состояние клиента = запрошенный URI + полученный ответ
***
### Ограничения REST
1. **Client-Server**: клиент и сервер разделены, развиваются отдельно
2. **Statelessness**: сервер не хранит информации о клиентах,
запрос содержит всю необходимую информацию для обработки,
в том числе информацию для идентификации клиента
3. **Cacheable**: в ответе явно говорится можно ли его кэшировать
4. **Uniform Interface**: API и потребители разделяют
один технический интерфейс (e.g. URI, Method, Media Type)
5. **Layered System**: допускается разделение системы на слои,
но компоненты одного слоя могут взаимодействовать
только с компонентами последующего слоя
(e.g. прокси, PayPal построенный на VISA)
6. **Code on Demand** (опционально): сервер может расширять
функциональность клиента (e.g. отправлять JavaScript)
***
### Подограничения Uniform Interface
- **Identification of resources**:
у каждого ресурса есть идентификатор,
не меняющийся при изменении состояния ресурса (e.g. URI)
- **Manipulation of resources through representations**:
ресурсы отделены от их представлений,
представления + метаданных должно быть достаточно,
чтобы модифицировать или удалить ресурс
- **Self-descriptive message**:
каждое сообщение должно включать достаточно информации, чтобы описать как обработать сообщение (e.g. Content-Type)
- **Hypermedia As The Engine Of Application State (HATEOAS)**:
гипермедия расширяет понятие гиперссылок,
ссылки используются для навигации по API
***
### Преимущества REST
- **Надежность**: не приходится сохранять информацию