ReSQL.ru
     
powered by simpleCommunicator - 2.0.28     © 2024 Programmizd 02
Мобильная версия    Контакт    Правила    FAQ    Помощь
Map
Доб. в избранное | Игнор. тему | Прикреп. тему | Пометить прочит. / непрочит. | Фильтр
Форумы / WCF, Web Services, Remoting [игнор отключен] [закрыт для гостей] / Web API. Как открыть интерфейсы?
25 сообщений из 51, страница 2 из 3
  2  все
Web API. Как открыть интерфейсы?
    #40014994
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
hVostt
Участник
fkthat
Для меня, как для разработчика, код контроллера это такая же спека, как все то же самое описанное на yaml/json. История показывает, что все эти подходы "понарисуем квадратиков со стрелочками, а чудо-инструмент нам сам по ним код сгенерирует" это полный фейл. Лет десять назад резюме разработчика без упоминания UML это было вообще не резюме. Ну и где сейчас этот UML - впиши его в резюме и тебя засмеют :)) Единственное применение кодогенерации сервера что я сразу так вижу, это когда тебе надо реализовать какой-то чужой API точно в соответствие с чужой спецификацией (например web-hooks для стороннего сервиса)


Не, ты путаешь слегка. OpenAPI это весьма конкретная спецификация, которую можно быстро разрабатывать.

Квадратики это вообще маст хев, но в квадратики 90% людей не умеют, поэтому как пещерные аборигены, объясняют на пальцах, пишут код на основе туманных тезисов, которые каждый понимает по-своему. Отсутствие качественного анализа и постановки с "квадратиками" выливается в большое количество мусорной бесполезной коммуникации, дефектов и отладки.

Тебе нужно не только контроллер, но и модели + аннотации + комментарии + инварианты ответов с описаниями.

А потом если что не так? В спецификации OpenAPI нужно поправить несколько строк, а контроллерах всё переколбашивать.

Просто ты с таким не сталкивался, сам так работал и понимаю тебя прекрасно. Однако на основе более глубокого опыта, разработка спецификации до написания кода -- эффективнее на порядочек. При любых раскладах практически.
...
Рейтинг: 0 / 0
03.11.2020, 18:27
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40014995
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
hVostt
Участник
fkthat
Я выше писал - интерфейс контроллеров и акций это ровно такая же спецификация API как и OpenAPI Doc, просто в другом формате, причем генерировать одно из другого можно и в ту и в другую сторону. Тут, наверное, просто вопрос, с чем команде удобней работать - описывать API на C# или на YAML/JSON. Точно так же как в древние времена COM - ты мог сначала написать кодом интерфейсы, а потом из них сгенерировать IDL/TypeLib, а мог наоборот - написать сначала IDL, а из него сгенерировать интерфейсы - и то и другое абсолютно равнозначно.


А теперь представь, тебе надо заинтегрироваться с другой командой. Тебе нужно, чтобы они тебе АПИ выставили, не один метод с парочкой полей, а несколько, допустим десяток со структурами разной сложности. Именно для тебя.

Ты к ним обращаешься, они согласны. Говорят, присылай спеку, мы реализуем.

Контроллер будешь колотить на коленке?
Ну вот это колхоз.
...
Рейтинг: 0 / 0
03.11.2020, 18:29
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015016
fkthat
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
fkthat
Участник
hVostt
Говорят, присылай спеку, мы реализуем.

Ну если так, тогда да. Я ведь раньше еще тут писал, что сценарий со спекой как раз хорошо подходит для реализации чужого API.
...
Рейтинг: 0 / 0
03.11.2020, 19:29
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015021
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
hVostt
Участник
fkthat
hVostt
Говорят, присылай спеку, мы реализуем.

Ну если так, тогда да. Я ведь раньше еще тут писал, что сценарий со спекой как раз хорошо подходит для реализации чужого API.


Не обязательно. Давай тебе кейс.

Есть команда бек, есть команда фронт. Проект один.
Ты пилишь свои задачи, фронт свои.
Завтра спринт заканчивается, и надо начать пилить новые задачи.
По твоей методике, получается, фронт должен сидеть ждать пока ты свои контроллеры напишешь? :)
А если вдруг что-то на фронте не зайдёт, они не заценят твою сгенерированную спеку, будут замечания, код переписывать?

Как бы вовсе не чужое API, а твоё. Но спека нужна раньше, чем начнётся реализация. Да она может и поменяться в процессе, подкорректироваться, но необходимо максимально снизить подобные ситуации.
...
Рейтинг: 0 / 0
03.11.2020, 19:40
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015027
fkthat
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
fkthat
Участник
hVostt
По твоей методике, получается, фронт должен сидеть ждать пока ты свои контроллеры напишешь? :)

А зачем писать контроллеры? Я же опять-таки выше уже писал - достаточно написать только интерфейсы контроллеров. Написал интерфейсы - кинул им ссылку на /swagger и пускай себе пилят, а ты пили уже реализацию своих контроллеров.
...
Рейтинг: 0 / 0
03.11.2020, 19:55
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015030
fkthat
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
fkthat
Участник
hVostt
Квадратики это вообще маст хев, но в квадратики 90% людей не умеют, поэтому как пещерные аборигены

ЛОЛ, так это именно пещерные аборигены общались тем, что жирафов да бегемотов на стене рисовали, а развитые люди чтобы общаться как раз и придумали алфавит и письменность
...
Рейтинг: 0 / 0
03.11.2020, 19:58
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015037
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
hVostt
Участник
fkthat
hVostt
По твоей методике, получается, фронт должен сидеть ждать пока ты свои контроллеры напишешь? :)

А зачем писать контроллеры? Я же опять-таки выше уже писал - достаточно написать только интерфейсы контроллеров. Написал интерфейсы - кинул им ссылку на /swagger и пускай себе пилят, а ты пили уже реализацию своих контроллеров.


Так по сути контроллеры и есть интерфейсы, не?
:)

90% кода контроллеров -- интерфейс. Это модели данных, аннотации, комментарии, инварианты ответов, маршруты, политики, полный фарш.

fkthat
ЛОЛ, так это именно пещерные аборигены общались тем, что жирафов да бегемотов на стене рисовали, а развитые люди чтобы общаться как раз и придумали алфавит и письменность


Так развитые не по одним лекалам. Поэтому нужны наглядные изображения бизнес-процессов, те самые "квадратики", согласованный словарь и куча всего, чтобы коммуникация была эффективной.
...
Рейтинг: 0 / 0
03.11.2020, 20:05
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015041
fkthat
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
fkthat
Участник
hVostt
Это модели данных, аннотации, комментарии, инварианты ответов, маршруты, политики, полный фарш.

Ну так все это по любому придется и в JSON писать. Тот же фарш только в другом виде.

hVostt
Так по сути контроллеры и есть интерфейсы, не?

Код: c#
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
// вот это "интерфейс"
[HttpPost("accounts")]
[ProducesResponseType(StatusCodes.Status201Created)]
public Task CreateAccount(AccountModel model) => throw new NotImplementedException();

// а вот это реализация
[HttpPost("accounts")]
[ProducesResponseType(StatusCodes.Status201Created)]
public async Task CreateAccount(AccountModel model)
{
    await _accountService.CreateAccountAsync(_mapper.Map<AccountDto>(model));
    return Created();
}
...
Рейтинг: 0 / 0
03.11.2020, 20:16
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015051
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
hVostt
Участник
fkthat,

ну так тебе надо написать код, скомпилить, запустить, открыть страничку со сваггером, вытащить файл, отдать.

и хрен бы сним, щитаешь это удобным -- ок. каждый извращается как может, ноу проблем ))

а теперь в твоём сваггере вносят комментарии/изменения, как обратно "фарш" затолкаешь?
...
Рейтинг: 0 / 0
03.11.2020, 20:37
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015111
fkthat
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
fkthat
Участник
hVostt
ну так тебе надо написать код, скомпилить, запустить, открыть страничку со сваггером, вытащить файл, отдать.

А если все это делать в обратном порядке (от JSON к коду контроллера), то количество шагов сильно меняется?

И, вот как это выглядит в C#:
Код: c#
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
public record WeatherModel(DateTimeOffset Date, int TemperatureC, string? Summary);

[ApiController]
[Route("api/weather")]
public class WeatherController : ControllerBase
{
    [HttpGet("")]
    public IEnumerable<WeatherModel> GetWeather() =>
         throw new NotImplementedException();
}



А вот, как то же самое выглядит в OpenAPI (слабонервным спойлер лучше не открывать )
 

Код: javascript
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.
{
  "x-generator": "NSwag v13.8.2.0 (NJsonSchema v10.2.1.0 (Newtonsoft.Json v9.0.0.0))",
  "openapi": "3.0.0",
  "info": {
    "title": "WeatherApi",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://localhost:7403"
    }
  ],
  "paths": {
    "/api/weather": {
      "get": {
        "tags": [
          "Weather"
        ],
        "operationId": "Weather_GetWeather",
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/WeatherModel"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "WeatherModel": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "date": {
            "type": "string",
            "format": "date-time"
          },
          "temperatureC": {
            "type": "integer",
            "format": "int32"
          },
          "summary": {
            "type": "string",
            "nullable": true
          }
        }
      }
    }
  }
}


...
Рейтинг: 0 / 0
04.11.2020, 00:19
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015116
fkthat
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
fkthat
Участник
hVostt,

А еще, кстати, когда ты будешь писать свой мультикилометровый JSON, то тебе придется регулярно генерить из него код, чтобы проверить что он вообще генерится и что генерится то, что ты ожидаешь. А когда я буду писать свой C#, то у меня студия сама сразу будет мои косяки подсвечивать :))
...
Рейтинг: 0 / 0
04.11.2020, 01:03
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015361
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
hVostt
Участник
fkthat
А если все это делать в обратном порядке (от JSON к коду контроллера), то количество шагов сильно меняется?


На этапе разработки и согласования API меняется конечно.
Более того, если для тебя это станет привычным, ты только выигрываешь во всех отношениях.


fkthat
А вот, как то же самое выглядит в OpenAPI (слабонервным спойлер лучше не открывать )


Прекрасно выглядит. Но только не в JSON:

Код: python
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.
x-generator: NSwag v13.8.2.0 (NJsonSchema v10.2.1.0 (Newtonsoft.Json v9.0.0.0))
openapi: 3.0.0
info:
  title: WeatherApi
  version: 1.0.0
servers:
  - url: 'https://localhost:7403'
paths:
  /api/weather:
    get:
      tags:
        - Weather
      operationId: Weather_GetWeather
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WeatherModel'
components:
  schemas:
    WeatherModel:
      type: object
      additionalProperties: false
      properties:
        date:
          type: string
          format: date-time
        temperatureC:
          type: integer
          format: int32
        summary:
          type: string
          nullable: true




fkthat
А еще, кстати, когда ты будешь писать свой мультикилометровый JSON, то тебе придется регулярно генерить из него код, чтобы проверить что он вообще генерится и что генерится то, что ты ожидаешь. А когда я буду писать свой C#, то у меня студия сама сразу будет мои косяки подсвечивать :))


Зафига мне мультикиллометровая спека, я её могу побить на кучу маленьких, на каждую задачу свой кусочек. Её можно затолкать в гит и видеть именно изменения в спецификации.

Т.е. я внесу изменения, и все увидят понятные изменения, все потребители АПИ.
Более того, в её разработке могут участвовать все: бек, фронт, аналитики, потребители.

А когда ты внесёшь изменения в контроллеры и модели, кто поймёт какие конкретно изменения отразятся на АПИ? Никто. Кроме тебя.

Просто ты АПИ полностью лочишь на себе. Индивидуально с твоей точки зрения -- это конечно хорошо. Теперь все пляшут и танцуют вокруг тебя :)

Но с командной точки зрения и в целом для разработки проектов -- это крайне хреновый подход.
...
Рейтинг: 0 / 0
04.11.2020, 23:24
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015362
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
hVostt
Участник
fkthat,

Я в общем, рекомендую попробовать.

Возьми, например, вот это: https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi

Ты получишь вменяемый редактор спеки с интеллисенсом, валидацией и всей остальной фигнёй.
Ни чем абсолютно не отличается от написания кода на C# :)
...
Рейтинг: 0 / 0
04.11.2020, 23:27
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015370
fkthat
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
fkthat
Участник
hVostt
fkthat,

Я в общем, рекомендую попробовать.

Возьми, например, вот это: https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi

Ты получишь вменяемый редактор спеки с интеллисенсом, валидацией и всей остальной фигнёй.
Ни чем абсолютно не отличается от написания кода на C# :)

Посмотрю. Да только у меня тут новый проект, где у людей вообще только POST, и, (внимание!), всегда возвращается только 200, а если какая-то ошибка, то она передается в body неким магическим кодом. Когда я спросил, что это за ХЕРНЯ, то меня "успокоили", тем, что все эти коды ошибок у них в конфлюенсе задокументированы. Вот так вот. А ты мне тут про OpenAPI.
...
Рейтинг: 0 / 0
05.11.2020, 00:06
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015371
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
hVostt
Участник
fkthat
Посмотрю. Да только у меня тут новый проект, где у людей вообще только POST, и, (внимание!), всегда возвращается только 200, а если какая-то ошибка, то она передается в body неким магическим кодом. Когда я спросил, что это за ХЕРНЯ, то меня "успокоили", тем, что все эти коды ошибок у них в конфлюенсе задокументированы. Вот так вот. А ты мне тут про OpenAPI.


Эээ, я с таким уже сталкивался :)
Забирали проект от внешнего подрядчика, а там типа того, POST, иногда GET и все ответы только 200.
На мой вопрос, это чё за херня, мне ответили, это JRPC...
Прастите што?
...
Рейтинг: 0 / 0
05.11.2020, 00:09
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015441
monstrU
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
monstrU
Участник
hVostt,

помнишь, на сайте как то была бурная дискуссия про то как ответы в web api оформлять -
вариант 1 - коды ответов 200, 400 500 использовать и давать тело ответа
вариант2 - код ответа 200 для успешного ответа и 500 для ошибок
в ваших проектах вы что используете ?
...
Рейтинг: 0 / 0
05.11.2020, 09:54
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015444
fkthat
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
fkthat
Участник
monstrU
hVostt,

помнишь, на сайте как то была бурная дискуссия про то как ответы в web api оформлять -
вариант 1 - коды ответов 200, 400 500 использовать и давать тело ответа
вариант2 - код ответа 200 для успешного ответа и 500 для ошибок
в ваших проектах вы что используете ?

Меня, вот еще интересует. Надо ли по best practice перечислять "очевидные" статусы - 401, 403, 500, или это лишнее.

200 надо указывать явно, потому что успешный ответ это не всегда 200, а может быть и любой другой двухсотый, те же, например, 201, 202, 204.
...
Рейтинг: 0 / 0
05.11.2020, 10:15
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015503
fkthat
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
fkthat
Участник
monstrU
hVostt,

помнишь, на сайте как то была бурная дискуссия про то как ответы в web api оформлять -
вариант 1 - коды ответов 200, 400 500 использовать и давать тело ответа
вариант2 - код ответа 200 для успешного ответа и 500 для ошибок
в ваших проектах вы что используете ?

Не все ошибки это 500. 500 это значит "неизвестный песец на сервере". Поэтому возвращать всегда 500 это полнейший говнодизайн.
...
Рейтинг: 0 / 0
05.11.2020, 12:22
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015681
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
hVostt
Участник
fkthat
Меня, вот еще интересует. Надо ли по best practice перечислять "очевидные" статусы - 401, 403, 500, или это лишнее.


Совершенно лишнее.

Вот здесь много чего интересного: https://swagger.io/docs/specification/describing-responses/
Смотри разделы "Default Response" и "Reusing Responses".

fkthat
Не все ошибки это 500. 500 это значит "неизвестный песец на сервере". Поэтому возвращать всегда 500 это полнейший говнодизайн.


Можно считать, что 500 означает, что требуется чинить.
"Рядовых" 500 быть не должно.
...
Рейтинг: 0 / 0
05.11.2020, 18:52
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40015684
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
hVostt
Участник
monstrU
помнишь, на сайте как то была бурная дискуссия про то как ответы в web api оформлять -
вариант 1 - коды ответов 200, 400 500 использовать и давать тело ответа
вариант2 - код ответа 200 для успешного ответа и 500 для ошибок
в ваших проектах вы что используете ?


вариант 1, кодов ответов больше.

надо понимать, что код ответа нужен не для удовлетворения внутреннего перфекциониста.
а для вполне конкретных задач. для организации единого мониторинга и построения понятного API.
...
Рейтинг: 0 / 0
05.11.2020, 18:54
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40016220
monstrU
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
monstrU
Участник
hVostt,

я по архитектуре веб сервисов дальше рассуждаю - рассматриваю какой вариант.
возьмем абстрактный пример получение по номеру паспорта ФИО и даты рождения человека.
то есть имеем сервис
/passport/person?passportNumber=41001234
и по нему возвращаем ответ 200 и тело запроса
Код: javascript
1.
2.
3.
4.
5.
6.
7.
{
 'Response':{
               'FIO':'Путин Вова',
               'BirthDaty':'19600201'
             },
 Explanations:[]
}


на запрос
/passport/person?passportNumber=4100123
возвращаем ответ 400 и тело
Код: javascript
1.
2.
3.
4.
{
   'Response':null,
   Explanations:['в номере паспорта должно быть 8 символов']
}


то есть подход какой - веб сервис возвращает не объект, а ответ на запрос.
а он уже состоит из ответа, когда он есть, или из объяснения причины отказа в ответе - отказ запроса по бизнес требованиям.
как то у меня такой подход сложился - у вас как ?
...
Рейтинг: 0 / 0
07.11.2020, 15:46
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40016225
fkthat
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
fkthat
Участник
monstrU

то есть подход какой - веб сервис возвращает не объект, а ответ на запрос.
а он уже состоит из ответа, когда он есть, или из объяснения причины отказа в ответе - отказ запроса по бизнес требованиям.
как то у меня такой подход сложился - у вас как ?

Да, вполне очеь даже нормальный подход. Только я бы возвращал завернутое в массив, потому что по REST URI типа /passport/person это коллекция и возвращать следует коллекцию. Если бы URI были типа /passport/person/41001234 то тогда либо 200 + объект, либо 404. Я придерживаюсь такого, что все что до "?" это URI ресурса, а все что после "?" это некие параметры представления этого ресурса (например, фильтрация, сортировка, пейджинг и т.п.). Что-то плохое до вопроса - это 404 (ресурса нет), а все что плохое после вопроса - это 400 - ресурс есть, но запрос к нему кривой.
...
Рейтинг: 0 / 0
07.11.2020, 16:22
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40016276
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
hVostt
Участник
monstrU
то есть подход какой - веб сервис возвращает не объект, а ответ на запрос.
а он уже состоит из ответа, когда он есть, или из объяснения причины отказа в ответе - отказ запроса по бизнес требованиям.
как то у меня такой подход сложился - у вас как ?


Если сложился, то хорошо.

Но лично на мой взгляд плохо.
Благодаря коду ответа (например, 200/400) мы имеем возможность легально возвращать разные типы данных. Соответственно, педалить один и тот же тип со значимыми полями, которые могут содержать null в случае ошибки -- хреново.

Т.е. содержать структуру, которая содержит Payload, (в вашем случае 'Response'), это прям убер костыль. Масло маслянное, HTTP уже даёт мощные инструменты для реализации чистого АПИ.
...
Рейтинг: 0 / 0
08.11.2020, 01:53
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40016724
monstrU
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
monstrU
Участник
fkthat,
обращу внимание - возвращается ответ веб сервиса, поэтому объект с ответом один.
в моем примере веб сервис возвращал только одну персону, поэтому объект с ответом был

'Response':{
'FIO':'Путин Вова',
'BirthDaty':'19600201'
},
если бы веб сервис был такой, что возвращает несколько персон, то само собой нужно было написать

'Response':[{
'FIO':'Путин Вова',
'BirthDaty':'19600201'
}]

hVostt,
объясню откуда выполз 'Response':null,
для подключения к веб-сервисам сделали агента на серверной стороне, который как раз возвращает CS объект с ответом веб сервиса. Физическое подключение было сделано библиотекой, которая сама ответ сериализовывала в cs объект (RestSharp был использован)

В случае невалидных параметров при коде 400 архитектура потребовала
1. выдать массив с разъяснением причин отказа проверки
2. и для успешной сериализации ответа поставить 'Response':null, так как Response заполняется в случае успешного ответа 200

Так что получилось, что когда пользуешься библиотекой с автоматической сериализацией ответа то оказалось удобно для 400 использовать вот такую структуру

{
'Response':null,
Explanations:['в номере паспорта должно быть 8 символов']
}
Да и архитектурно получается вроде логичное объяснение: при отказе при валидации нет ответа веб сервиса и есть разъяснение причин отказа

fkthat, hVostt
вообще мнение по вопросу опять поделилось - один голос сказал за, второй голос против.
кстати в прошлом топике про веб апи так же было.
так что видимо на уровне предпочтений.
мой пример вылез из того, что реально загрузкой занимается библиотека с автоматический сериализацией ответа
...
Рейтинг: 0 / 0
10.11.2020, 07:08
| Ответить | Цитировать | Написать  
Web API. Как открыть интерфейсы?
    #40016727
fkthat
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
fkthat
Участник
monstrU
fkthat,
обращу внимание - возвращается ответ веб сервиса, поэтому объект с ответом один.
в моем примере веб сервис возвращал только одну персону, поэтому объект с ответом был

'Response':{
'FIO':'Путин Вова',
'BirthDaty':'19600201'
},
если бы веб сервис был такой, что возвращает несколько персон, то само собой нужно было написать

'Response':[{
'FIO':'Путин Вова',
'BirthDaty':'19600201'
}]

Да можно и так, в общем-то, в REST что и плохо, что нет по сути никаких стандартов. Просто, допустим, мы решили доработать наш API поддержкой запроса /passport/person/?firstName=Вова и тогда он уже будет возвращать:
Код: javascript
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
'Response':[
  {
    'FIO':'Путин Вова',
    'BirthDaty':'19600201'
  },
  {
    'FIO':'Пупкин Вова',
    'BirthDaty':'19730908'
  }
]


Получится не очень удобно. Все-таки, на мой вкус, запрос к коллекции должен возвращать коллекцию.
...
Рейтинг: 0 / 0
10.11.2020, 07:43
| Ответить | Цитировать | Написать  
25 сообщений из 51, страница 2 из 3
  2  все
Форумы / WCF, Web Services, Remoting [игнор отключен] [закрыт для гостей] / Web API. Как открыть интерфейсы?
Целевая тема:
Создать новую тему:
Автор:
Закрыть
Цитировать
Найденые пользователи ...
Разблокировать пользователей ...
Читали тему (0):
Читали форум (0):
Пользователи онлайн (0):
Польз. соглашение
NoSQL.ru, Чат Кролика       Пашэ: Рисунки, Чат       Фотоальбом: Участники, Встречи
Закрыть
Start [/forum/topic.php?fid=19&msg=40015370&tid=1396648]:
 0ms
get settings:
 26ms
get forum list:
 15ms
check forum access:
 3ms
check topic access:
 3ms
track hit:
 59ms
get topic data:
 10ms
get forum data:
 3ms
get page messages:
 491ms
get tp. blocked users:
 2ms
others: 345ms
total:  957ms
созд. / загр.: 957ms
x
x
Закрыть


Просмотр
0 / 0
Close
Debug Console [Select Text]