This is a plugin that only has a peer dependency to
piral-axios brings to the table is a single Pilet API extension called
axios that is used by
piral. Axios is a library for making HTTP requests.
The following functions are brought to the Pilet API.
Represents an Axios instance already configured for use in the app shell.
::: summary: For pilet authors
You can use the
axios object from the Pilet API to communicate with your backend. This instance has advantages over creating a fresh instance from Axios.
For instance, it is already wired up with the authentication system and communicating to the right backend. As such relative URLs can be used when doing requests.
For details on using Axios, see the Axios documentation.
::: summary: For Piral instance developers
The provided library only brings API extensions for pilets to a Piral instance.
For the setup of the library itself you'll need to import
createAxiosApi from the
The integration looks like:
Via the options the default settings such as the
baseURL can be defined. These options are taken directly from
piral-axios plays nicely together with authentication providers such as
piral-adal. As such authentication tokens are automatically inserted on requests to the base URL.
Piral is released using the MIT license. For more information see the license file.