All notes
Raml

Good examples

resourceTypes:



#%RAML 1.0 
title: Pet shop
version: 1
baseUri: /shop
 
types:
  Pet:
    properties:
      name: string
      kind: string
      price: number
    example:
      name: "Snoopy"
      kind: "Mammal"
      price: 100
 
resourceTypes:
 
  Collection:
    get:
      responses:
        200:
          body:
            application/json:
              type: <<item>>[]
    post:
      body:
        application/json:
          type: <<item>>
 
  Member:
    put:
      body:
        application/json:
          type: <<item>>
    delete:
      responses:
        204:
 
/pets:
  type: { Collection: {item: Pet} }
  get:
    queryParameters:
      priceLessThen:
        type: number
      priceMoreThen:
        type: number
      petKind:
        enum: [bird, mammal]
 
  /{id}:
    type: { Member: {item : Pet} }

API Workbench


# http://apiworkbench.com/docs/

# Install Atom

# Install through atom package manager
apm install api-workbench