https://github.com/wearelucid/api-fetcher

Generates multiple JSON files from fetching API endpoints (i18n supported) 🛬
https://github.com/wearelucid/api-fetcher

api-fetcher json-files wordpress

Last synced: 13 days ago
JSON representation

Generates multiple JSON files from fetching API endpoints (i18n supported) 🛬

• Host: GitHub
• URL: https://github.com/wearelucid/api-fetcher
• Owner: wearelucid
• Created: 2017-09-05T14:14:31.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T08:22:18.000Z (almost 2 years ago)
• Last Synced: 2024-10-07T02:48:33.115Z (about 1 month ago)
• Topics: api-fetcher, json-files, wordpress
• Language: JavaScript
• Size: 490 KB
• Stars: 5
• Watchers: 5
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Api fetcher

[![npm version](https://img.shields.io/npm/v/@wearelucid/api-fetcher.svg?style=flat-square)](https://www.npmjs.com/package/@wearelucid/api-fetcher)

Generates multiple JSON files from fetching (WordPress) API endpoints (i18n supported) 🚀

## Installation

```bash

yarn add @wearelucid/api-fetcher

```

## Usage

Be aware that this package uses ES6 syntax!

Add a script to your package.json

```JSON

"scripts": {

  "fetch": "node fetchData.js"

}

```

Since node currently does not support es2015 module syntax, we need to install [`babel-cli`](https://yarnpkg.com/en/package/babel-cli) and add the script like so:

```JSON

"scripts": {

  "fetch": "babel-node --presets env -- fetchData.js"

}

```

```bash

yarn fetch

```

## Example

### Full Example (Wordpress)

```javascript

import fetcher from 'api-fetcher'

const config = {

  savePath: './static/data',

  compressJSON: true, // setting this to false may help debugging :-)

  perPage: 5000, // arbitrary

  itemsPerPage: 10, // set for pagination (default will automatically be 10)

  languages: [

    { lang: 'de', locale: 'de_CH' },

    { lang: 'en', locale: 'en_US' }

  ],

  apiUrl: 'https://your-backend/api'

}

fetcher.log.printText('Lucid')

fetcher.log.printConfig(config)

// fetch paginated posts

fetcher.paginate('posts', { posts: { method: fetcher.getWPPostType, postType: 'posts', transforms: [removeFieldsFromPost] } },

// fetch bundled data

fetcher.bundle('basic', {

  pages: { method: fetcher.getWPPostType, postType: 'pages', transforms: [removeFieldsFromPost, decodeTitle], filters: [showOnlyPublished] },

  menus: { method: fetcher.getWPMenus },

  options: { method: fetcher.getWPOptionsPage, slug: 'options' },

  // If you need to get categories and custom taxonomies

  categories: { method: fetcher.getWPCategories },

  formats: { method: fetcher.getWPCustomTaxonomy, taxonomy: 'formats' }

}, config)

/**

* Filter (Note: This filter is an example. It is not needed. Wordpress by default only delivers published posts and pages)

*/

function showOnlyPublished (data) {

  return (data && data.length) ? data.filter(p => p.status === 'publish') : data

}

/**

* Delete fields we don't need (anymore)

*/

function removeFieldsFromPost (data) {

  return fetcher.applyToOneOrMany(_removeFieldsFromPost, data)

}

function _removeFieldsFromPost (data) {

  delete data._links

  return data

}

```

### Generating Multiple Bundles

If you want to generate multiple json bundles you can invoke `fetcher.bundle()` with different a name like so:

```javascript

fetcher.bundle('basic', {

  pages: { method: fetcher.getWPPostType, postType: 'pages', transforms: [removeFieldsFromPost, decodeTitle] },

  posts: { method: fetcher.getWPPostType, postType: 'posts', transforms: [removeFieldsFromPost, decodeTitle] }

}, config)

```

### Generating Paginated Collections

You can also generated paginated collections like so:

```javascript

fetcher.paginate('posts', { posts: { method: fetcher.getWPPostType, postType: 'posts', transforms: [removeFieldsFromPost, decodeTitle] } }, config)

fetcher.paginate('pages', { pages: { method: fetcher.getWPPostType, postType: 'pages', transforms: [removeFieldsFromPost, decodeTitle] } }, config)

```

In some cases you might also want to load all items of the once you loaded paginated (for having all the data):

```javascript

fetcher.bundle('fileName', { posts: { method: fetcher.getWPPostType, postType: 'posts', transforms: [removeFieldsFromPost, decodeTitle] } }, config)

```

Default items per page will be set to `10`.

You can provide the variable `itemsPerPage` inside your config.

```

itemsPerPage: 10

```

This will generate a collection of json files (with your specified naming), in this case:

```bash

posts.de.1.json

posts.de.2.json

posts.de.3.json

```