PHP Classes
elePHPant
Icontem

File: raml/songs.raml

Recommend this page to a friend!
  Classes of Mike Stowe  >  PHP RAML to HTML  >  raml/songs.raml  >  Download  
File: raml/songs.raml
Role: Auxiliary data
Content type: text/plain
Description: Auxiliary data
Class: PHP RAML to HTML
Parse RAML of an API to generate documentation
Author: By
Last change:
Date: 4 years ago
Size: 693 bytes
 

Contents

Class file image Download
#%RAML 0.8
 
title: World Music API
baseUri: http://example.api.com/{version}
version: v1
traits:
  - paged:
      queryParameters:
        pages:
          description: The number of pages to return
          type: number
  - secured: !include raml/githubrepo.raml
/songs:
  is: [ paged, secured ]
  get:
    queryParameters:
      genre:
        description: filter the songs by genre
  post:
  /{songId}:
    get:
      responses:
        200:
          body:
            application/json:
              schema: !include raml/githubrepo.raml
            application/xml: !include raml/githubrepo.raml
    delete:
      description: |
        This method will *delete* an **individual song**