Git Product home page Git Product logo

raml-spec's Introduction

The RESTful API Modeling Language (RAML) Spec

###Licensing Contributors License Agreement

Branding Guidelines

Index

###Introduction: RAML Overview
RAML Markup Language

####Includes

Named Parameters:

Named Parameters with Multiple Types

Basic Information:

Root
Base URI and baseUriParameters
Protocols
Default Media Type
Schemas
URI Parameters
User Documentation

Resources and Methods:

Resources and Nested Resources
Template URIs and URI Parameters Absolute URI
Query Parameters
Body
Web Forms

Schemas and Responses:

Schemas
Responses
Headers

Security:

Declaration
Type
OAuth 1.0
OAuth 2.0
Usage: Applying a Security Scheme to an API

###References: Normative References
Informative References

githalytics.com alpha

##Contributing

Please, follow these steps to contribute with the RAML Spec project:

  • Check the Contributors License Agreement
  • Fork this repository.
  • Clone the forked repository.
  • Apply the changes on master.
  • Commit, Push.
  • Generate Pull Request.

Please, follow these steps to accept a contribution

  • Verify the Pull Request.
  • If it's correct: Merge/Accept.
  • Move to gh-pages branch (git checkout gh-pages) and run ./specs_publish.sh (this script copies the resulting raml-0.8.md file from master to the current branch gh-pages and places it in the following path: ./spec.md which is needed to have the specs published in the site). Note: This is a shell script, only working on UNIX based OS.

raml-spec's People

Contributors

aldonline avatar usarid avatar comptly avatar xaka avatar philzen avatar svacas avatar blakeembrey avatar suryatech avatar

Watchers

James Cloos avatar Thai Thinh avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.