Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patrickcate/nuxt-jsonapi
JSON:API client for Nuxt.js
https://github.com/patrickcate/nuxt-jsonapi
json-api nuxt nuxt-module nuxtjs
Last synced: about 2 months ago
JSON representation
JSON:API client for Nuxt.js
- Host: GitHub
- URL: https://github.com/patrickcate/nuxt-jsonapi
- Owner: patrickcate
- License: mit
- Created: 2020-12-09T03:35:24.000Z (almost 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-07-29T17:16:09.000Z (about 2 months ago)
- Last Synced: 2024-07-29T23:07:40.113Z (about 2 months ago)
- Topics: json-api, nuxt, nuxt-module, nuxtjs
- Language: JavaScript
- Homepage:
- Size: 4.22 MB
- Stars: 40
- Watchers: 3
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# nuxt-jsonapi
[![npm version][npm-version-src]][npm-version-href] [![npm downloads][npm-downloads-src]][npm-downloads-href] [](https://github.com/patrickcate/nuxt-jsonapi/actions/workflows/ci.yml) [![Codecov][codecov-src]][codecov-href] [![License][license-src]][license-href]
> Easy JSON:API client integration for Nuxt.js
[📖 **Release Notes**](./CHANGELOG.md)
Version `2.x` support Nuxt `3.x`.
[Version `1.x`](https://github.com/patrickcate/nuxt-jsonapi/tree/v1.0.0) supports Nuxt `2.x`
## Introduction
`nuxt-jsonapi` adds easy [JSON:API](https://jsonapi.org) client integration to [Nuxt](https://nuxtjs.org). It is a loose wrapper around the excellent [Kitsu](https://github.com/wopian/kitsu/tree/master/packages/kitsu) JSON:API client.
This module globally injects a `$jsonApi` instance you can use to access the client anywhere using `this.$jsonApi` (options API) or `const { $jsonApi } = useNuxtApp()` (composition API).
## Setup
1. Add `nuxt-jsonapi` dependency to your project
```bash
npm run add nuxt-jsonapi # or npm install nuxt-jsonapi
```
2. Add `nuxt-jsonapi` to the `modules` section of `nuxt.config.js`
```js
{
modules: [
// Simple usage
'nuxt-jsonapi',
// With options
[
'nuxt-jsonapi',
{
baseURL: 'http://www.example.com/api',
/* other module options */
},
],
]
}
```
3. If you didn't pass options with step #2, add a `jsonApi` object to your `nuxt.config.js` to configure module options:
```js
export default {
modules: ['nuxt-jsonapi'],
jsonApi: {
baseURL: 'http://www.example.com/api',
/* other module options */
},
}
```
---
## ❗ Important
If you do not specify a `baseURL` option, a default `/jsonapi` URL will be used. **This is almost certainly not what you want** so be sure it is set correctly.
---
## Usage
Refer to [Kitsu's excellent documentation](https://github.com/wopian/kitsu/tree/master/packages/kitsu) for all the feature's the client offers.
You can access the client with:
### Options API
```js
this.$jsonApi
```
**Example:**
```js
export default defineNuxtComponent({
async asyncData({ $jsonApi }) {
const { data } = await $jsonApi.get('/article')
return {
articles: data,
}
},
})
```
### Composition API
```js
const { $jsonApi } = useNuxtApp()
```
**Example:**
```vue
import { useNuxtApp, useAsyncData } from '#app'
const { $jsonApi } = useNuxtApp()
const { data: articles } = await useAsyncData(() => $jsonApi.get('/article'), {
transform: ({ data }) => data,
})
```
## Development
1. Clone this repository
2. Install dependencies using `yarn install` or `npm install`
3. Start development server using `yarn dev` or `npm run dev`
4. Run automated tests using `yarn test` or `npm run test`
- Run `npm run dev:prepare` to generate type stubs.
- Use `npm run dev` to start [playground](./playground) in development mode.
## License
[MIT License](./LICENSE)
Copyright (c) Patrick Cate
[npm-version-src]: https://img.shields.io/npm/v/nuxt-jsonapi/latest.svg
[npm-version-href]: https://npmjs.com/package/nuxt-jsonapi
[npm-downloads-src]: https://img.shields.io/npm/dt/nuxt-jsonapi.svg
[npm-downloads-href]: https://npmjs.com/package/nuxt-jsonapi
[github-actions-ci-src]: https://github.com/patrickcate/nuxt-jsonapi/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/patrickcate/nuxt-jsonapi/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/github/patrickcate/nuxt-jsonapi.svg
[codecov-href]: https://codecov.io/gh/patrickcate/nuxt-jsonapi
[license-src]: https://img.shields.io/npm/l/nuxt-jsonapi.svg
[license-href]: https://npmjs.com/package/nuxt-jsonapi