60 lines
2.4 KiB
Markdown
60 lines
2.4 KiB
Markdown
# vue-resource [](https://circleci.com/gh/pagekit/vue-resource) [](https://www.npmjs.com/package/vue-resource) [](https://www.jsdelivr.com/package/npm/vue-resource) [](https://www.npmjs.com/package/vue-resource) [](https://www.npmjs.com/package/vue-resource)
|
|
|
|
The plugin for [Vue.js](http://vuejs.org) provides services for making web requests and handle responses using a [XMLHttpRequest](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest) or JSONP.
|
|
|
|
## Features
|
|
|
|
- Supports the [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) API and [URI Templates](https://medialize.github.io/URI.js/uri-template.html)
|
|
- Supports [interceptors](docs/http.md#interceptors) for request and response
|
|
- Supports latest Firefox, Chrome, Safari, Opera and IE9+
|
|
- Supports Vue 1.0 & Vue 2.0
|
|
- Compact size 14KB (5.3KB gzipped)
|
|
|
|
## Installation
|
|
You can install it via [yarn](https://yarnpkg.com/) or [NPM](http://npmjs.org/).
|
|
```
|
|
$ yarn add vue-resource
|
|
$ npm install vue-resource
|
|
```
|
|
|
|
### CDN
|
|
Available on [jsdelivr](https://cdn.jsdelivr.net/npm/vue-resource@1.5.0), [unpkg](https://unpkg.com/vue-resource@1.5.0) or [cdnjs](https://cdnjs.com/libraries/vue-resource).
|
|
```html
|
|
<script src="https://cdn.jsdelivr.net/npm/vue-resource@1.5.0"></script>
|
|
```
|
|
|
|
## Example
|
|
```js
|
|
{
|
|
// GET /someUrl
|
|
this.$http.get('/someUrl').then(response => {
|
|
|
|
// get body data
|
|
this.someData = response.body;
|
|
|
|
}, response => {
|
|
// error callback
|
|
});
|
|
}
|
|
```
|
|
|
|
## Documentation
|
|
|
|
- [Configuration](docs/config.md)
|
|
- [HTTP Requests/Response](docs/http.md)
|
|
- [Creating Resources](docs/resource.md)
|
|
- [Code Recipes](docs/recipes.md)
|
|
- [API Reference](docs/api.md)
|
|
|
|
## Changelog
|
|
|
|
Details changes for each release are documented in the [release notes](https://github.com/pagekit/vue-resource/releases).
|
|
|
|
## Contribution
|
|
|
|
If you find a bug or want to contribute to the code or documentation, you can help by submitting an [issue](https://github.com/pagekit/vue-resource/issues) or a [pull request](https://github.com/pagekit/vue-resource/pulls).
|
|
|
|
## License
|
|
|
|
[MIT](http://opensource.org/licenses/MIT)
|