Перейти к основному содержимому

165 записей с тегом "REST"

Посмотреть все теги

· 8 мин. чтения

1. Введение​

Спецификация OpenAPI (ранее спецификация Swagger) стандартизирует язык документации REST API и не зависит от платформы. Мы можем создавать документы OpenAPI в форматах YAML или JSON .

С другой стороны, Swagger — это набор инструментов для реализации и работы со стандартом. Некоторые из них бесплатны, некоторые с открытым исходным кодом, а некоторые являются коммерческими. Эти инструменты помогают нам проектировать, документировать и использовать REST API.

В этой статье мы узнаем, как форматировать текстовые описания в наших документах OpenAPI.

2. Редакторы OpenAPI​

· 3 мин. чтения

1. Обзор​

В этой статье мы сравним REST и gRPC, два архитектурных стиля для веб-API.

2. Что такое ОТДЫХ?​

REST (Representational State Transfer) — это архитектурный стиль, предоставляющий рекомендации по разработке веб-API.

Он использует стандартные методы HTTP 1.1, такие как GET , POST , PUT и DELETE , для работы с ресурсами на стороне сервера . Кроме того, REST API предоставляют предварительно определенные URL-адреса , которые клиент должен использовать для подключения к серверу.

· 7 мин. чтения

1. Проблема​

Развитие REST API — сложная задача, для решения которой доступно множество вариантов. В этой статье обсуждаются некоторые из этих вариантов.

2. Что в договоре?​

Прежде всего, нам нужно ответить на один простой вопрос: что такое контракт между API и клиентом?

· 5 мин. чтения

1. Обзор​

В этой статье основное внимание будет уделено возможности обнаружения REST API, HATEOAS и практическим сценариям, основанным на тестах.

2. Зачем делать API доступным для обнаружения​

Обнаруживаемость API — это тема, которой не уделяется должного внимания. Как следствие, очень немногие API понимают это правильно. Это также то, что, если все сделано правильно, может сделать API не только RESTful и удобным, но и элегантным.

Чтобы понять возможность обнаружения, нам нужно понять ограничение Hypermedia As The Engine Of Application State (HATEOAS). Это ограничение REST API связано с полной возможностью обнаружения действий/переходов на ресурсе из гипермедиа (фактически гипертекста) как единственного драйвера состояния приложения.

· 6 мин. чтения

1. Обзор​

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

ElasticSearch — это поисковая система, основанная на Apache Lucene , бесплатной библиотеке программного обеспечения для поиска информации с открытым исходным кодом. Он предоставляет распределенную полнотекстовую поисковую систему с веб-интерфейсом HTTP и документами JSON без схемы.

В этой статье рассматривается REST API ElasticSearch и демонстрируются основные операции только с использованием HTTP-запросов.

2. Настройка​

· 4 мин. чтения

1. Обзор​

В этом руководстве мы рассмотрим основные функциональные возможности среды Apache Meecrowave .

Meecrowave — это облегченная среда микросервисов от Apache , которая очень хорошо работает с CDI, JAX-RS и JSON API. Его очень просто настроить и развернуть. Это также устраняет проблемы с развертыванием тяжелых серверов приложений, таких как Tomcat, Glassfish, Wildfly и т. д.

2. Зависимость от Maven​

· 1 мин. чтения

Зрелый REST API может потребовать много работы, а гибкая публикация ресурсов обычно является уравновешивающим действием.

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

Язык поиска/запросов для API имеет наибольший смысл — он позволяет выполнять одну чистую операцию, при этом открывая API для мощного поиска.

./b4fca6b7551d64e916be22bff9c025dd.png

Основы языка запросов REST​

./409d748df9357494e7685154b4d86b27.png

Расширенный язык запросов REST​

· 3 мин. чтения

1. Обзор​

Описание RESTful API играет важную роль в документации. Одним из распространенных инструментов, используемых для документирования REST API, является Swagger 2 . Однако один полезный атрибут, используемый для добавления описания, устарел. В этом руководстве мы найдем решение для устаревшего атрибута описания с помощью Swagger 2 и OpenAPI 3 и покажем, как их можно использовать для описания приложения Spring Boot REST API.

2. Описание API​

По умолчанию Swagger создает пустое описание для имени класса REST API. Поэтому нам нужно указать подходящую аннотацию для описания REST API. Мы можем либо использовать Swagger 2 с аннотацией @Api , либо использовать аннотацию @Tag в OpenAPI 3.

3. Чванство 2​

· 3 мин. чтения

Создание REST API — нетривиальная задача — от высокоуровневых ограничений RESTful до кропотливой работы по обеспечению того, чтобы все работало и работало хорошо.

Spring сделала REST первоклассным гражданином, и платформа развивалась как на дрожжах. С выпуском Spring 5 REST стал закаленным в боях и полностью зрелым .

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

Руководство начинается с основ — начальной загрузки REST API, конфигурации Spring MVC, базовой настройки.

Затем он погружается в более продвинутые области REST — HATEOAS и разбивку на страницы, обработку ошибок и тестирование.

./7226ae98806ce71d7e1c88847394dbb2.png

Основы API REST​

./81119d04398c3d0154c2510f8ecea327.png

Расширенные темы REST API​

./5249399dc48b02b49871c763ef15dc15.png

Тестируйте и используйте API​

./1f096779d4d24396bcedcb67414e5890.png

Другие весенние уроки​

· 3 мин. чтения

1. Обзор​

В традиционном веб-приложении для входа в систему обычно требуется отправить имя пользователя и пароль на сервер для аутентификации. Хотя эти элементы теоретически могут быть параметрами URL в GET-запросе, очевидно, что гораздо лучше инкапсулировать их в POST-запрос.

Однако должен ли выход из системы быть доступен через запрос GET, поскольку он не требует отправки какой-либо конфиденциальной информации?

В этом уроке мы рассмотрим различные аспекты этого дизайна.

2. Сеансы на стороне сервера​