GithubHelp home page GithubHelp logo

api-generator's Introduction

Api generator for frontend

Generates an object with API urls as values

Installation

npm install --save-dev api-url-tree-generator

or

yarn add --dev api-url-tree-generator

Usage

const baseUrl = "https://something.com"
const apiRaw = {
  simpleRoute: 'simple-route',
  'other-route': 'other-route',
  'node': {
    nestedRoute: 'nested-route'
  }
}

const options = {
  // ...
}

const api = generateApi(baseUrl, apiRaw, options)
/*
  api => {
      simpleRoute: 'https://something.com/simple-route',
      'other-route': 'https://something.com/other-route',
      'node': {
        nestedRoute: 'https://something.com/node/nested-route'
      }
  }

  Also, api.node translates to https://something.com/node
*/

// request to 'https://something.com/simple-route'
const response = await fetch(api.simpleRoute);

// request to 'https://something.com/node'
const response = await fetch(api.node);

// request to 'https://something.com/node/nested-route'
const response = await fetch(api.node.nestedRoute);

Options

Option Type Description
withTailingSlash boolean Adds tailing slash to url

License

MIT

api-generator's People

Contributors

jamshoot66 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.