API Platform API

(4 reviews)

Public search API

This Notebook explains how to use the API Platform API V2 to search through public APIs within the Anypoint Platform.

##Documentation

The following RAML fragment describes the search method parameters

/public/apis:
  description: Search through all public APIs within the Anypoint Platform.
  get:
    queryParameters:

      requireRaml:
        type:        boolean
        required:    false
        default:     true
        description: |
          Filter APIs that have RAML definitions

      query:
        type:        string
        required:    false
        description: |
          A list of keywords for matching API name, tags or description in a search.

      offset:
        type:        integer
        required:    false
        example:     0
        minimum:     0
        maximum:     10000
        default:     0
        description: |
          Skip over a number of elements by specifying an offset value for the query

      limit:
        type:        integer
        required:    false
        example:     80
        default:     100
        minimum:     10
        maximum:     250
        description: |
          Limit the number of elements on the response

      sort:
        type:        string
        required:    false
        example:     name
        description: |
          Property to sort by

      ascending:
        type:        boolean
        required:    false
        example:     true
        description: | 
          Order for sorting

##Using the API

First we need to setup the API client

Now we setup the public search API endpoint which is located at:

GET /public/apis

###Examples

Querying APIs with search criteria 'public api'

Querying APIs with search criteria 'public api' that have a RAML definition

Querying APIs with search criteria 'public api' and pagination params


Reviews