The axios-api-naming's intro from seyto

axios-api-naming's Introduction

This library is for axios based projects.

Steps to build an intercepted axios where requests are refined.

The API is defined like this. There is also an example in __tests__

const EP = {
  books: {
   'create': {
      url: '/user',
      method: 'get'
   },
   user: {
    'login': {
      url: '/login',
      method: 'post'
    },
    'secrets': {
      url: '/secrets',
      method: 'post',
      headers: {
        authorization: true
      }
    }
  }
}

Create/use an axios instance of your config.

const ax = axios.create({
  baseURL: 'http://localhost:3000'
})

Assign urlInterceptor to your axios.

const restContract: APIContract = {
  localStorageContract: {
    // not used
  },
  requestHeadersContract: {
    // these headers will be applied to all request. @Deprecating
    generalHeaders: {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
  }
}

// create options for url interceptor
const options = {
  authorizationSnippet: (headers: any) => {
    // this option is used when you assign 'authorization: true' in your contract.
    // Basically, you get to define what your headers/body/path should look like
    // when contract demands authorization.
    Object.assign(headers, { 'Authorization': 'Bearer'  })
    return Promise.resolve()
  }
}

urlInterceptor(EP, restContract)

// aaand done

// now call using your axios instance like this

ax.use('books.create')
  .then(res => {
    // do something
  })