dynamic-apis

1.2.2 • Public • Published

dynamic-apis

dynamic apis,use proxy create restful controller

install

npm i dynamic-apis

usage

create controller

import { createController } from "dynamic-apis";
//使用json-server 测试
const baseURL = "http://127.0.0.1:3000/";
const postCtrler = createController("posts", baseURL);
//with header
const postCtrler = createController("posts", baseURL, {
  "some-header": "header-value",
});
//dynamic header
let count = 0;
const postCtrler = createController("posts", baseURL, () => {
  return {
    "some-header": "header-value",
    "count-header": count++,
    AuthToken: getToken(),
  };
});

get all

let posts = await postCtrler.get();
//fetch   :GET  http://127.0.0.1:3000/posts

get by id

let posts = await postCtrler.get(1);
//fetch   :GET  http://127.0.0.1:3000/posts/1

//batch
let posts = await postCtrler.get(1, 2, 3);
//fetch   :GET  http://127.0.0.1:3000/posts/1,2,3
//warning json-server not support

query

let posts = await postCtrler.get({ author: "saharan" });
//fetch   :GET  http://127.0.0.1:3000/posts?author=saharan

let posts = await postCtrler.get({ author: ["saharan","you","others" });
//fetch   :GET  http://127.0.0.1:3000/posts?author=saharan&author=you&author=others

let posts = await postCtrler.get({ user: { author: "saharan" } });
//fetch   :GET  http://127.0.0.1:3000/posts?user.author=saharan

post

let result = await postCtrler.add({
  title: "dynamic api",
  author: "saharan",
});
//fetch :POST http://127.0.0.1:3000/posts
//body :{...}
//postCtrler.post also work

put

let result = await postCtrler.put(1, {
  title: "dynamic api",
  author: "saharan",
});
//fetch :PUT http://127.0.0.1:3000/posts/1
//body :{...}
//postCtrler.update also work

patch

let result = await postCtrler.modify(1, {
  author: "saharan",
});
//fetch :PATCH http://127.0.0.1:3000/posts/1
//body :{...}
//postCtrler.patch also work

delete

let result = await postCtrler.del(1);
//fetch :DELETE http://127.0.0.1:3000/posts/1

//batch
let result = await postCtrler.del(1, 2, 3);
//fetch :DELETE http://127.0.0.1:3000/posts/1,2,3

path,id support

const result = await postCtrler.id(2).comments.get();
//fetch :GET  http://127.0.0.1:3000/posts/1/comments
//  postCtrler.path(2).comments.get() also work

const addResult = await postCtrler.id(2).comments.add({
  body: "some comment!!!",
  postId: 2,
});
//fetch :POST  http://127.0.0.1:3000/posts/1/comments

//some server api name contains (get|add |...) method prefix

const result = await someCtrler.path("getUser").get(userId);

//fetch :GET http://127.0.0.1:3000/some.../getUser/userId

New Features

ActionsMap As A Arg

const postCtrler = createController(
  "posts",
  baseURL,
  {
    "some-header": "header-value",
  },
  (handler) => {}, //beforeSends   do something before send fetch request
  (handler) => {}, //afterReceives do something after receive data from respose
  { //actionsMap somthing.get() == something.fetch()  
    get: "fetch",
    post: ["add"],
    put: ["update"],
    patch: ["modify"],
    delete: ["del", "remove"],
  },
  ["get","add","update","modify"] //parseActions, getSomething =>fetch:GET  something 
);

Every Propertie Can Use As A Function

const result = await postCtrler(2).comments.get();
//fetch :GET  http://127.0.0.1:3000/posts/1/comments
//  postCtrler.path(2).comments.get() also work
//  postCtrler.id(2).comments.get();

const result = await postCtrler(2).comments(1).get();
//fetch :GET  http://127.0.0.1:3000/posts/1/comments/1

Package Sidebar

Install

npm i dynamic-apis

Weekly Downloads

62

Version

1.2.2

License

MIT

Unpacked Size

22.6 kB

Total Files

8

Last publish

Collaborators

  • lv-saharan