API Resources
When adding a new API using the API Publisher, you can define API resources. API Resources field appears at last in the Add New API page as follows:
An API is made up of one or more resources. Each resource handles a particular type of request and is analogous to a method (function) in a larger API.
API resources can accept following attributes:
URL Pattern | A URL pattern is a string used to map an actual URL. For example, a URL pattern is a mapping such as |
HTTP Verb | The HTTP methods which specify the desired action to be performed on the resource. These methods can be GET, POST, PUT, DELETE or OPTIONS. Multiple methods can be selected. |
Auth Type | Facilitates resource-level authentication where different levels of authentication can be specified to each HTTP method of the resource. The auth type is cached in the API Manager for performance reasons. If you change the auth type through the UI, it takes about 15 minutes to refresh the cache and during that time, the server returns the old auth type. If you want the changes reflected immediately, please restart the server after changing the auth type. |
Throttling Tier | See Resource-Level Throttling. |
Action | Allows to move the resource up and down the list or delete it. |
Once a request is accepted by a resource, it will be mediated through an in-sequence. Any response from the back-end is handled through the out-sequence. Fault sequences are used to mediate errors that might occur in either sequence. The default in-sequence, out-sequence and fault sequence are generated when the API is published.
Go back to API Resources field in Creating an API page.