https://github.com/mdmahfuzrp/react-api-call
Say Goodbye to Api Headaches: Effortless Api Call With React-Api-Call
https://github.com/mdmahfuzrp/react-api-call
api api-call apicall apicalls apis mahfuzrp mdmahfuzrp mrp next react react-api react-api-call react-api-hooks reactapicall submit-api
Last synced: 3 months ago
JSON representation
Say Goodbye to Api Headaches: Effortless Api Call With React-Api-Call
- Host: GitHub
- URL: https://github.com/mdmahfuzrp/react-api-call
- Owner: mdmahfuzrp
- License: mit
- Created: 2024-05-09T23:09:41.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-05-30T14:39:07.000Z (about 1 year ago)
- Last Synced: 2025-04-03T10:11:11.485Z (3 months ago)
- Topics: api, api-call, apicall, apicalls, apis, mahfuzrp, mdmahfuzrp, mrp, next, react, react-api, react-api-call, react-api-hooks, reactapicall, submit-api
- Language: JavaScript
- Homepage: https://reactapicall.vercel.app
- Size: 44.9 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### Say Goodbye to Api Headaches:
Effortless Api Call With [react-api-call](https://github.com/mdmahfuzrp/bachelor-task-server)
Introducing react-api-call, the ultimate npm package for effortless API requests. Simplify your development with just 2-3 lines of code to handle GET, POST, PUT, and DELETE operations. This user-friendly API request library enhances your productivity by streamlining best practices for making API calls. Perfect for developers, react api call is the efficient solution you need to boost your projects and improve your coding experience.
#
#### Install react-api-call:
```javascript
npm i react-api-call
```
#
### You can follow this steps for your usecase.
##### Get Method:
```javascript
import { useGetMethod } from "react-api-call";
const App = () => {
const { isLoading, refetch, response } = useGetMethod({
apiUrl: "example/api/v1/users",
token: "your-token",
tokenType: "Bearer",
headersConfig: {
"Content-type": "application/json",
},
});
console.log(response);
return (
Hello World
);
};
export default App;
```
##### Submit Method:
```javascript
import { useSubmitMethod } from "react-api-call";
const App = () => {
const { handleSubmit, isLoading } = useSubmitMethod({
token: "your-token",
tokenType: "Bearer",
headersConfig: {
"Content-type": "application/json",
},
});
const handlePostStatus = async () => {
const postData = {
name: "John Smith",
status: true,
};
const { error, response } = await handleSubmit({
url: "example/api/v1/users",
data: postData,
});
console.log(error, response);
};
return (
Add Status
);
};
export default App;
```
##### Delete Method:
```javascript
import { useDeleteMethod } from "react-api-call";
const App = () => {
const { handleDelete, isDeleting } = useDeleteMethod({
token: "your-token",
headersConfig: {
"Content-type": "application/json",
},
tokenType: "Bearer",
});
const handleDeleteStatus = async () => {
const apiUrl = "example.com/status/1";
await handleDelete({ url: apiUrl });
};
return (
Delete
);
};
export default App;
```
### Now it's time for manage your cookies
##### Set Cookies:
```javascript
import { useCookies } from "react-api-call";
const App = () => {
const { setCookies } = useCookies();
const handleSetCookies = () => {
// in set cookies you need to pass: name, value, expires in day
setCookies("admin-token", token, 7);
};
return (
Set Token
);
};
export default App;
```
##### Get Cookies:
```javascript
import { useCookies } from "react-api-call";
const App = () => {
const { getCookies } = useCookies();
const handleGetCookies = () => {
// for get cookies value, you need to pass "name" only
getCookies("admin-token");
};
return (
Get Token
);
};
export default App;
```
##### Delete Cookies:
```javascript
import { useCookies } from "react-api-call";
const App = () => {
const { deleteCookie } = useCookies();
const handleDeleteCookies = () => {
// for delete cookies you need to pass: "name" only
deleteCookie("admin-token");
};
return (
Delete Token
);
};
export default App;
```
#
### List of parameters, that you can pass if needed:
| Parameters | Description | Usecase | Status | Type | Default Value |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | -------- | ---------- | ---------------- |
| `token` | If you need to pass token in your api calls then you can pass this otherwise not. | `useGetMethod`, `useSubmitMethod`, `useDeleteMethod` | Optional | `string` | null |
| `tokenType` | Default tokenType is `Bearer` but if you need to change, then you can pass this parameters with value. | `useGetMethod`, `useSubmitMethod`, `useDeleteMethod` | Optional | `string` | Bearer |
| `headersConfig` | Default is application/json but if needed you change pass this with values. | `useGetMethod`, `useSubmitMethod`, `useDeleteMethod` | Optional | `object` | application/json |
| `apiUrl` | Pass your api url in useGetMethod Hooks. | `useGetMethod` | Required | `string` | null |
| `onError` | After a submit or delete request, (errors) if you need to show error then you can pass a function in this parameters, and you also get error response in your function what you have pass in this parameters. | `useSubmitMethod`, `useDeleteMethod` | Optional | `function` | null |
| `onSuccess` | After a submit or delete request, (success) if you need to show success or showing a alert or something then you can pass a function in this parameters, and you also get success response in your function what you have pass in this parameter. | `useSubmitMethod`, `useDeleteMethod` | Optional | `function` | null |
| `refetch` | If after submit or delete you need to refetch or call some api then you can pass function in this parameters. | `useSubmitMethod`, `useDeleteMethod` | Optional | `function` | null |
| `method` | For submit request default method is `post` and for delete request default method is `delete` so if you need to change you can pass this parameters with your methods. | `useSubmitMethod`, `useDeleteMethod` | Optional | `string` | post & delete |
### Contribution From Your End
If you have confidence to contribute in this package, YOU ARE WELCOME.
#### Todo
- Component mount unmount loading handle for get api
- Cache in for 5 minutes
##### Author
```
MD MAHFUZ RP
Software Engineer & Tech Entrepreneur
Developer & Creator of @react-api-call
```
