RAML - The simplest way to design APIs

  •        0

RAML is a language for the definition of HTTP-based APIs that embody most or all of the principles of Representational State Transfer (REST). The RAML specification (this document) defines an application of the YAML 1.2 specification that provides mechanisms for the definition of practically-RESTful APIs, while providing provisions with which source code generators for client and server source code and comprehensive user documentation can be created.

http://raml.org/
https://github.com/raml-org/raml-spec

Tags
Implementation
License
Platform

   




Related Projects

nsxraml - A RAML Specification Describing the NSX for vSphere API


This repository holds a RAML specification of the NSX for vSphere 6.x API. For more details on RAML, please visit http://raml.org.This RAML file has been generated from information that can be found in the "NSX vSphere API Guide" documentation that is available in PDF format at vmware.com.

pyraml - RAML (REST API Markup Language) enhanced loader, parameter converter, and API wrapper.


RAML (REST API Markup Language) enhanced loader, parameter converter, and API wrapper.

nsxramlclient - A pseudo dynamic client in python that takes the RAML File as input, and composes the API call needed


This Python based client for NSX for vSphere 6.x gets its API structure information (e.g. URLs, parameters, schema, etc.) from a RAML file which describes the NSX for vSphere REST API. It has been developed and tested for use with VMware NSX for vSphere 6.x.Also, in the NSXv 6.3 version of the nsx raml spec XML Comments and pre-filled content was introduced in the RAML spec to improve readability of the created HTML and PDF artifacts. This change may break existing code, so version 2.0.6 of the nsxramlclient now removes any XML comments and pre-filled content.

Swagger - The World's Most Popular API Framework


Swagger is a powerful open source framework backed by a large ecosystem of tools that helps you design, build, document, and consume your RESTful APIs. The goal of Swagger is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.

connexion - Swagger/OpenAPI First framework for Python on top of Flask with automatic endpoint validation & OAuth2 support


Connexion is a framework on top of Flask that automagically handles HTTP requests based on OpenAPI 2.0 Specification (formerly known as Swagger Spec) of your API described in YAML format. Connexion allows you to write a Swagger specification, then maps the endpoints to your Python functions; this makes it unique, as many tools generate the specification based on your Python code. You can describe your REST API in as much detail as you want; then Connexion guarantees that it will work as you specified.With Connexion, you write the spec first. Connexion then calls your Python code, handling the mapping from the specification to the code. This incentivizes you to write the specification so that all of your developers can understand what your API does, even before you write a single line of code.

flask-raml


Flask-RAML (REST API Markup Language) API server with parameter conversion, response encoding, and examples.

platypus - Swagger-based Documentation for VMware's REST API's


Platypus is an initiative to improve documentation across a number of VMware's products (see Supported Products) as described using Open API and displaying these local APIs using VMware's API Explorer component. Open API definitions as declared in the root of the project are displayed as 'local' definitions in the API Explorer. API Explorer can also display official API definitions provided by VMware at https://code.vmware.com/apis.Previously Platypus required specifying which API you wanted to access in the Swagger UI, and only allowed using one API at a time. In this new version all APIs are provided simultaneously with no change to the container.

9292-api-spec - Unofficial API specification / documentation for 9292.


Unofficial API specification / documentation for 9292.

bcx-api - API documentation and wrappers for Basecamp 2


Basecamp 2 has its own API. It is not compatible with the Basecamp Classic API or the Basecamp 3 API. The core ingredients are still the same, though. This is a REST-style API that uses JSON for serialization and OAuth 2 for authentication.All URLs start with https://basecamp.com/999999999/api/v1/. SSL only. The path is prefixed with the account id and the API version. If we change the API in backward-incompatible ways, we'll bump the version marker and maintain stable support for the old URLs.

boutine-rest-api - Documentation for Boutine.com Rest API


Documentation for Boutine.com Rest API

community-plugins - Home for Openfire plugins that are not included in the core set of plugins


Openfire Meetings (download from here) provides high quality, scalable video conferences using Jitsi Meet and Jitsi Videobridge. Download the remotecontrol.zip file and install if you want to grant remote control access during screen/desktop sharing.Chat Api (documentation here) The Chat API Plugin is an extension of the REST API plugin by Roman Soldatow to enable chat and groupchat over a RESTful API and Server Sent Events (SSE) API in addition to the ability to manage Openfire by REST requests and responses. This plugin’s functionality is useful for web applications that provide a complete chat and group chat solution. It should be used with the optional monitoring and bookmarks plugins.

bc3-api - API documentation for Basecamp 3


The Basecamp 3 API is not compatible with the Basecamp Classic API or the Basecamp 2 API. All integrations will start fresh with the new API. The core ingredients are the same, though: Basecamp 3 is a REST-style API that uses JSON for serialization and OAuth 2.0 for authentication.If you're making a public integration with Basecamp for others to enjoy, you must use OAuth 2.0. OAuth 2.0 allows users to authorize your application to use Basecamp on their behalf without having to copy/paste API tokens or touch sensitive login information.

mobicheckin-api-documentation - Detailled documentation of the REST API provided by MobiCheckin


Detailled documentation of the REST API provided by MobiCheckin

venue-driver-api-documentation - Documentation and examples for using the Venue Driver REST API.


Documentation and examples for using the Venue Driver REST API.

edocu-api - Contains REST API documentation


Contains REST API documentation

model-s-api - An unofficial documentation of the Tesla Model S REST API


An unofficial documentation of the Tesla Model S REST API

FirmwaterLMS-API - Documentation and sample code for the REST-style Firmwater LMS API.


Documentation and sample code for the REST-style Firmwater LMS API.

api-docs - Yetti ReST API documentation


Yetti ReST API documentation

kassomat-api-doc - Official kassomat REST API Documentation


Official kassomat REST API Documentation

basecamp-classic-api - Official API documentation for Basecamp Classic


This is the API for Basecamp Classic (basecamphq.com). It is not compatable with the Basecamp 2 API or Basecamp 3 API.The Basecamp Classic API is implemented as vanilla XML over HTTP using all four verbs (GET/POST/PUT/DELETE). Every resource, like Post, Comment, or TodoList, has their own URL and are manipulated in isolation. We've tried to make the API follow the REST principles as much as we can.