forked from kontur-web-courses/web-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
web-api.html
410 lines (289 loc) · 10.9 KB
/
web-api.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
<!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">
## Web API на .NET Core
***
### Создание Web API на .NET Core
```bash
dotnet new webapi -n WeatherApi
```
***
### Program.cs
```cs
public class Program
{
public static void Main(string[] args)
{
CreateHostBuilder(args).Build().Run();
}
public static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.UseStartup<Startup>();
});
}
```
***
### Startup.cs
```cs
public class Startup
{
// Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers();
}
// Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
app.UseHttpsRedirection();
app.UseRouting();
app.UseEndpoints(endpoints => { endpoints.MapControllers(); });
}
}
```
***
### WeatherForecastController.cs
```cs
[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
private readonly ILogger<WeatherForecastController> _logger;
public WeatherForecastController(ILogger<WeatherForecastController> logger)
{
_logger = logger; // Пример Dependency Injection
}
[HttpGet]
public IEnumerable<WeatherForecast> Get()
{
return Enumerable.Range(1, 5).Select(index => ...).ToArray();
}
}
```
***
### Атрибуты MVC
**Управление путями**
`[Route("api/[controller]")]`, `[HttpGet("{id}")]`
e.g. `GET api/weatherforecast/5`
**Управление методами**
`[HttpGet]`, `[HttpPost]`, `[HttpDelete]`
`[HttpPut]`, `[HttpPatch]`,
`[HttpHead]`, `[HttpOptions]`,
**Управление источником данных**
`[FromHeader]`, `[FromQuery]`, `[FromRoute]`,
`[FromForm]`, `[FromBody]`, можно дописать свои
***
### Https в разработке
Запустить команду `register-dev-certs.cmd`,
или `register-dev-certs.sh`
чтобы доверять сапоподписанным сертификатам .NET Core
***
### Запуск Web API
```bash
dotnet run -p WeatherApi
```
https://localhost:5001/api/weatherforecast
http://localhost:5000/api/weatherforecast
***
### Подготовка к задаче UsersApi
1. Паттерн Repository
2. Data Transfer Object
3. Запуск тестов
***
### Паттерн 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
И многие другие варианты...
***
### Запуск тестов
1. Тесты находятся в `Tests`
2. Задать `BaseUrl` в `Configuration.cs`
3. Запуск встроенными в IDE инструментами или запуск Tests как консольного приложения.
Удобно открыть две IDE:
- одну для редактирования и запуска API
- другую для запуска и отладки тестов.
***
### Задача 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` можно импортировать в программы для взаимодействия с Web API, например, 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**
- **Песочница**, чтобы делать запросы
- **Автогенерация клиентов и серверов** по описанию
</script></section>
<section data-markdown><script type="text/template">
## Инструменты для взаимодействия с API
***
### Демо Postman
1. Import / Import File
Из `/WebApi/Samples/UsersApi.postman_collection.json`
Также можно импортировать из Swagger
2. File / Settings / General / SSL certificate verification
*Установить в OFF*
3. Collections / UsersApi / Выбрать ... / Edit / Variables / baseUrl
*Записать адрес, где развернуто приложение*
4. Collections / UsersApi / Открыть любой запрос
*Запустить*: увидеть статус код, тело, результаты тестов
*Найти*: Params, Headers, Body, Pre-request Script, Tests
5. Runner / Collection Runner / UsersApi / Run UsersApi
*Посмотреть результат прохождения тестов*
6. Console
*Показать, что можно смотреть информацию по запросам*
***
### Postman — UI для бэкендера
</script></section>
<section data-markdown><script type="text/template">
## Вопросы?
</script></section>
</div></div>
</body>
</html>