RAML Wizard-RAML API Design Tool

Example

In the chronicle of the BookMobile API, resources like /users and /authors were defined, alongside methods such as GET and POST to interact with these resources.

Scenario

A developer crafting a new API for a library application seeks guidance on organizing their digital tomes. The wizard advises on structuring resources for books and authors, and on using methods to retrieve or submit information, casting a spell of understanding over the once-daunting task.

Example

The tale unfolds with /books/{bookTitle} and query parameters like author and publicationYear, allowing one to fetch specific books or filter through the library.

Scenario

In a quest to enhance a music streaming service's API, a bard requires assistance in filtering songs by genre and year. The wizard, with a flick of his wand, demonstrates the use of URI and query parameters to refine searches, bringing harmony to the service.

Example

In the narrative of retrieving a book, the API specifies a 200 HTTP status code response with details of the book in JSON format, guiding developers in expecting and handling API responses effectively.

Scenario

An alchemist working on a potion recipe sharing platform needs to know how users will receive potion details. The wizard elucidates the crafting of HTTP responses, ensuring that seekers of alchemical knowledge receive their recipes in an orderly fashion.