2.0.2 • Published 4 years ago

apicon.js v2.0.2

Weekly downloads
4
License
ISC
Repository
github
Last release
4 years ago

What apicon.js is

apicon.js is lightweight and easy to use library for HTTP requests. Works good with React.js.

Getting started 🚀

Installation

    npm install apicon.js

Examples with React.js

Easiest way to use 😏

import React, { useEffect, useState } from "react";
import { get } from "apicon.js";

const App = () => {
  const endpoint = " endpoint here ";
  const [data, setData] = useState({});

  useEffect(() => {
    get(endpoint).then(data => setData(data));
  });
};

Optionally you can send request body and headers. Just use second parameter of get / post method this way:

import React, { useEffect, useState } from "react";
import { get } from "apicon.js";

const App = () => {
  const endpoint = " endpoint_here ";
  const headers = { request_headers };
  const dataToSend = { data };
  const payload = JSON.stringify(data);

  const [data, setData] = useState({});

  useEffect(() => {
    get(endpoint, headers, payload).then(data => setData(data));
  });
};

There is a two avaiable methods to import - get and post, same way to use.

Advanced usage 😱

import React, { useEffect, useState } from "react";
import { Apicon } from "apicon.js";

const App = () => {
  const endpoint = " endpoint here ";
  const ApiconInstance = new Apicon(endpoint);
  const [data, setData] = useState({});

  useEffect(() => {
    Apicon.get().then(data => setData(data));
  });
};

Optionally you can send request body and headers. Just set them to Apicon instance.

import React, { useEffect, useState } from "react";
import { Apicon } from "apicon.js";

const App = () => {
  const endpoint = " endpoint here ";
  const ApiconInstance = new Apicon(endpoint);
  const [data, setData] = useState({});

  const headers = { request_headers };
  const dataToSend = { data_for_request };
  const payload = JSON.stringify(data);

  ApiconInstance.setHeaders(headers);
  ApiconInstance.setPayload(payload);

  useEffect(() => {
    Apicon.get().then(data => setData(data));
  });
};

This way is better when you need to store data from request and endpoint address in apicon instances. You can use as much instances as you need. If you need to get informations about Apicon class fields and methods get to section UML diagrams and check class diagram.

UML diagrams

Class Diagram

Class Diagram

Sequence Diagram without Apicon Instance

NoInstance Diagram

Sequence Diagram with Apicon Instance

NoInstance Diagram

Using this module will make code cleaner when we need simple data fetch.

Thank you for using this module. :blush:

Github Repository

2.0.2

4 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago