RESTful API

The @ginjou/with-rest-api package connects Ginjou to standard RESTful APIs. It follows the query parameter and header conventions established by json-server v0.x.x, making it compatible with many existing mocking tools and API standards.

Installation

Install the provider.

pnpm add @ginjou/with-rest-api

yarn add @ginjou/with-rest-api

npm install @ginjou/with-rest-api

bun add @ginjou/with-rest-api

Setup

Initialize the fetcher and register it in your root component (App.vue or app.vue).

<script setup lang="ts">
import { defineFetchersContext } from '@ginjou/vue'
import { createFetcher } from '@ginjou/with-rest-api'

defineFetchersContext({
    default: createFetcher({
        url: 'https://api.example.com'
    })
})
</script>

<template>
    <RouterView />
</template>

<!-- WIP -->
<script>
  // ...
</script>

Fetcher Conventions

The createFetcher implementation relies on specific query parameters and headers to handle data operations.

Pagination

The fetcher translates Ginjou's pagination state into _start and _end query parameters.

• _start: Zero-based index of the first item.
• _end: Zero-based index of the last item (exclusive).

Sorting

Sorting uses _sort and _order parameters.

• _sort: Comma-separated list of fields.
• _order: Comma-separated list of directions (asc or desc).

Filtering

Filters map to query parameters using field suffixes.