http-data-request

http-data-request

Create customized data request methods for web projects

Features

• Automatically save and apply authorization tokens
• Unified handling of exception information
• Customizable status code
• Customizable authorization data node
• Provides quick access functions for each request method
• Provides a function to cancel all current requests

Examples and Documentation

Documentation and examples please visit below sites

• Github pages

Installation

# npm
npm i http-data-request
# yarn
yarn add http-data-request
# pnpm
pnpm add http-data-request

Setup to your project

// /src/config/http/index.js
import { useHttpDataRequest } from 'http-data-request'

const options = {
  baseUrl: 'https://example.com/api',
}

export const {
  http, get, post, put, patch, del, cancel
} = useHttpDataRequest(options)

// vite.config.js
import { fileURLToPath, URL } from 'node:url'
import { resolve } from 'path'
import { defineConfig } from 'vite'

export default defineConfig({
  resolve: {
    alias: {
      '@': fileURLToPath(new URL('./src', import.meta.url)),
      '@api': fileURLToPath(new URL('./src/api', import.meta.url)),
      '@http': fileURLToPath(new URL('./src/config/http', import.meta.url))
    }
  },
  ...
})

Usage

API definition

// /src/api/user.js
import { get, post } from '@http'

export function getUser (userId) {
  return get(`/user/${userId}`)
}

In some component

<template>
  <div>
    <div>
      User name: {{ user.name }}
    </div>
    <div>
      User age: {{ user.age }}
    </div>
  </div>
</template>
<script setup>
import { ref } from 'vue'
import { getUser } from '@api/user'

const user = ref({})

getUser(10).then(data => {
  user.value = data
})
</script>

Cancel request

Cancel a download request

<template>
  <div>
    <div>
      ...order form
    </div>
    <button
      type="button"
      @click="save"
    >Save order</button>
    <!--
    Clicking before the data is saved successfully
    will cancel the data request
    -->
    <button
      type="button"
      @click="cancel"
    >Cancel</button>
  </div>
</template>
<script setup>
import { ref } from 'vue'
import { DialogMessageSuccess } from 'v-dialogs'
import { cancel } from '@http'
import { saveOrder } from '@api/order'

function save () {
  saveOrder({ ...formData }).then(() => {
    DialogMessageSuccess('Order save successfully')
  })
}
</script>

Global Settings

import {
  useHttpDataRequest
  EXCEPTION_BUSINESS,
  EXCEPTION_AUTH_INVALID
} from 'http-data-request'
// Use v-dialogs to display exception message for example
import { DialogMessageError, DialogAlertError } from 'v-dialogs'
import { logout } from './auth'

const options = {
  baseUrl: 'https://example.com/api',
  // globally set the exception handler
  exception (message, type) {
    // display business exceptions
    if (type === EXCEPTION_BUSINESS) {
      DialogMessageError(message)
      return
    }

    // display rest of other exceptions
    DialogAlertError(message)

    // some action for user authorization expired
    if (type === EXCEPTION_AUTH_INVALID) {
      // cancel all current request when
      cancel()
      // logout and redirect to login page
      logout()
    }
  }
}

export const {
  http, get, post, put, patch, del, cancel
} = useHttpDataRequest(options)

Changelog

1.0.0 (2024-08-01)

• http-data-request plugin release