Функциональные и нефункциональные требования, относящиеся к веб-API

Question

- это разработка RESTful API в JSON, которая позже будет потребляться веб-интерфейсом как «функциональное» или «не функциональное» требование?

Answer 1

Это вопрос является сложным и зависит от человека мнения мои мысли по поводу этой темы в следующем:

XML - Идеально для высоко структурированной информации и JSON возникла в качестве стандарта для легко обмениваться данными объектов JavaScript между системами ,

Современный Javascript предназначен для нативно чтения данных (JSON) и преобразовывает его в объекты так с моей точки зрения, в случае, если RESTful API будет потребляться веб-интерфейса - это более функциональная требование, чем неработоспособной.

Answer 2

Это не так. «Разработка RESTful API в JSON» не является обязательным требованием, а просто описывает процесс реализации одного или нескольких базовых требований.

Но вы, вероятно, ссылаетесь на функциональное требование.

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

Такое функциональное требование может быть:

(идентификатор 1) Система в стадии разработки должны предложить следующую информацию к внешним системам через интерфейс: (таблица требуемой информации)

Затем вы можете разбить это на более подробные функциональные требования, один из которых может быть:

(идентификатор 2) Система в стадии разработок должны предложить свою информации, указанной в (ссылке на идентификатор, 1) к внешним систем в формате JSON через интерфейс, который доступен для REST клиентов, для того, чтобы подать внешней системы XYZ.

Нефункциональные требования, напротив, рассказывают больше о характеристиках API. Такие, как:

• Производительность
• безопасности
• Надежность
• Юзабилити
• ремонтопригодность
• Переносимость

Потому что эти вещи трудно измерить, вы можете добавить больше функциональных требований которые более подробно определяют ожидаемое поведение (например, Максимум. время отклика).

Источник:

https://www.ireb.org/content/downloads/2-syllabus-foundation-level/ireb_cpre_syllabus_fl_en_v22.pdf