1. Обзор
В этой статье мы представляем RESTful API Modeling Language (RAML) — независимый от поставщика язык с открытой спецификацией, построенный на YAML 1.2 и JSON для описания RESTful API.
Мы рассмотрим базовый синтаксис и файловую структуру RAML 1.0, а также продемонстрируем, как определить простой API на основе JSON. Мы также покажем, как упростить обслуживание RAML-файлов с помощью include
. А если у вас есть устаревшие API, использующие схему JSON, мы покажем, как включить схемы в RAML.
Затем мы познакомим вас с несколькими инструментами, которые упростят ваше знакомство с RAML, включая инструменты разработки, генераторы документации и другие.
Наконец, мы закончим описанием текущего состояния спецификации RAML.