Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imjuni/jin-curlize
create curl command from FastifyRequest
https://github.com/imjuni/jin-curlize
curl curl-commands fastify fastifyjs
Last synced: 16 days ago
JSON representation
create curl command from FastifyRequest
- Host: GitHub
- URL: https://github.com/imjuni/jin-curlize
- Owner: imjuni
- License: mit
- Created: 2020-06-01T14:49:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-14T16:06:00.000Z (10 months ago)
- Last Synced: 2024-10-19T10:27:11.020Z (2 months ago)
- Topics: curl, curl-commands, fastify, fastifyjs
- Language: TypeScript
- Homepage:
- Size: 530 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jin-curlize
[](https://npmcharts.com/compare/jin-curlize?minimal=true)
[](https://github.com/imjuni/jin-curlize)
[](https://github.com/imjuni/jin-curlize/issues)
[](https://www.npmjs.com/package/jin-curlize)
[](https://github.com/imjuni/jin-curlize/blob/master/LICENSE)
[](https://github.com/imjuni/jin-curlize/actions/workflows/ci.yml)
[](https://codecov.io/gh/imjuni/jin-curlize)
[](https://github.com/prettier/prettier)
jin-curlize create curl command from FastifyRequest.
Why?
1. automatic create curl command from FastifyRequest
1. Quickly retry error request
1. Support querystring, header, body replacer
## Table of Contents
- [How to works?](#how-to-works)
- [Usage](#usage)
- [create curl command](#create-curl-command)
- [create axios request configuration](#create-axios-request-configuration)
- [Example](#example)
- [Options](#options)
- [createFromFastify3](#createfromfastify3)
- [createAxiosFromFastify3](#createaxiosfromfastify3)
- [How do I add x-request-id?](#how-do-i-add-x-request-id)
- [jin-axios-curlize](#jin-axios-curlize)
## How to works?
`jin-curlize` create curl command from `FastifyRequest`. URL, querystirng, header create using `IncomingMessage` in `FastifyRequest`. For example,
- `IncomingMessage`.`IncomingHttpHeaders` to `--header` option
- `IncomingMessage`.url to querystring and href
But `IncomingMessage` is already ended ReadableStream in `FastifyReqest`. So body create using `FastifyRequest`.body.
```mermaid
flowchart LR
IMH[IncomingMessage.IncomingHttpHeaders] --> JC[jin-curlize]
IMU[IncomingMessage.url] --> JC
FB[FastifyRequest.body] --> JC
JC --> C[curl command]
JC --> A[AxiosRequestConfig]
```
## Usage
### create curl command
```ts
import fastify from 'fastify';
import { createFromFastify3 } from 'jin-curlize';
const server = fastify({
logger: {
transport: {
target: 'pino-pretty',
},
serializers: {
res(reply) {
return {
statusCode: reply.statusCode,
};
},
req(request) {
return {
method: request.method,
url: request.url,
path: request.routerPath,
parameters: request.params,
headers: request.headers,
curl: createFromFastify3(request, { prettify: false }),
};
},
},
},
});
server.listen({ host: '0.0.0.0', port: 3000 });
```
### create axios request configuration
```ts
import fastify from 'fastify';
import { createAxiosFromFastify3 } from 'jin-curlize';
const fastify = fastify({
logger: {
transport: {
target: 'pino-pretty',
},
serializers: {
res(reply) {
return {
statusCode: reply.statusCode,
};
},
req(request) {
return {
method: request.method,
url: request.url,
path: request.routerPath,
parameters: request.params,
headers: request.headers,
axios: JSON.stringify(createAxiosFromFastify3(request)),
};
},
},
},
});
server.listen({ host: '0.0.0.0', port: 3000 });
```
## Example
Axios Request
```js
await axios.request({
method: 'post',
url: `http://localhost:3000/post-form`,
headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
data: querystring.stringify({
name: 'ironman',
ability: ['energy repulsor', 'supersonic flight'],
}),
});
```
Create command
```bash
curl -X POST 'http://localhost:3000/post-form' --header 'content-type: application/x-www-form-urlencoded' --data name='ironman' --data ability='energy repulsor' --data ability='supersonic flight'
```
## Options
### createFromFastify3
| Name | Requirement | Description |
| --------------------- | ----------- | -------------------------------------------------------------- |
| prettify | require | Apply prettifing. Add newline and backslash add on line-ending |
| indent | optional | Only work on prettify set true, make space size |
| disableFollowRedirect | optional | If set true, remove `--location` option from command |
| changeHeaderKey | optional | change header key case. eg. `content-type` to `Content-Type` |
| replacer.querystring | optional | replacer for querystring |
| replacer.body | optional | replacer for body |
| replacer.header | optional | replacer for header |
### createAxiosFromFastify3
| Name | Requirement | Description |
| -------------------- | ----------- | ------------------------------------------------------------ |
| changeHeaderKey | optional | change header key case. eg. `content-type` to `Content-Type` |
| replacer.querystring | optional | replacer for querystring |
| replacer.body | optional | replacer for body |
| replacer.header | optional | replacer for header |
## How do I add x-request-id?
- [Add x-request-id on querystring](https://github.com/imjuni/jin-curlize/blob/master/examples/x-request-id/index.mjs)
- [Add transaction_id on querystring](https://github.com/imjuni/jin-curlize/blob/master/examples/transaction-id/index.mjs)
## jin-axios-curlize
If you want that curl command generate from AxiosRequest, use [jin-axios-curlize](https://www.npmjs.com/package/jin-axios-curlize) package.