4 записи с тегом "RAML"

1. Обзор​

В нашей учебной статье по RAML мы представили язык моделирования RESTful API и создали простое определение API, основанное на единственном объекте с именем Foo . Теперь представьте реальный API, в котором у вас есть несколько ресурсов сущностного типа с одинаковыми или похожими операциями GET, POST, PUT и DELETE. Вы видите, как ваша документация по API может быстро стать утомительной и повторяющейся.

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

2. Наш API​

1. Обзор​

В этой статье мы представляем RESTful API Modeling Language (RAML) — независимый от поставщика язык с открытой спецификацией, построенный на YAML 1.2 и JSON для описания RESTful API.

Мы рассмотрим базовый синтаксис и файловую структуру RAML 1.0, а также продемонстрируем, как определить простой API на основе JSON. Мы также покажем, как упростить обслуживание RAML-файлов с помощью include . А если у вас есть устаревшие API, использующие схему JSON, мы покажем, как включить схемы в RAML.

Затем мы познакомим вас с несколькими инструментами, которые упростят ваше знакомство с RAML, включая инструменты разработки, генераторы документации и другие.

Наконец, мы закончим описанием текущего состояния спецификации RAML.

1. Введение​

В наших первых двух статьях о RAML — языке моделирования RESTful API — мы представили некоторый базовый синтаксис, включая использование типов данных и схемы JSON, и показали, как упростить определение RAML путем извлечения общих шаблонов в типы ресурсов и признаки .

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

2. Наш API​

1. Введение​

В этой четвертой статье из нашей серии о RAML — языке моделирования RESTful API — мы демонстрируем , как использовать аннотации для определения пользовательских свойств для спецификации RAML API. Этот процесс также называется расширением метаданных спецификации.

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

2. Объявление типов аннотаций​